Enterprise API Gateway — Security (how to use)

← Back to Enterprise API Gateway overview

Security

Module: Enterprise API Gateway

Where to open in admin

  1. Log in to Admin.
  2. Open sidebar menu Enterprise API Gateway.
  3. Click Security.
  4. Direct route (for admins): admin/enterprise_api_gateway/enterprise_api_gateway_security

What this screen is for

Integrate external systems via REST API or outbound webhooks.

How to use — step by step

  1. Enable API in finance settings.
  2. Create API key/token and store securely.
  3. Use Bearer token on requests; add Idempotency-Key on writes.
  4. Configure webhook URL and verify HMAC signatures on receiver.

Common buttons & actions

  • Create key
  • Rotate token
  • Test webhook

Required permissions

Staff need the eag_settings feature with: view, edit.

Assign under Setup → Staff → Roles → Permissions.

Related guides

See the Enterprise API Gateway overview for module-wide workflows, API, and setup.

Did you find this article useful?