Search Knowledge Base Articles

Supplier Portal — API Keys (how to use)

← Back to Supplier Portal overview

API Keys

Module: Supplier Portal

Where to open in admin

  1. Log in to Admin.
  2. Open sidebar menu Supplier Portal.
  3. Click API Keys.
  4. Direct route (for admins): admin/supplier_portal/supplier_portal_api_keys

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 sp_settings feature with: view, edit.

Assign under Setup → Staff → Roles → Permissions.

Related guides

See the Supplier Portal overview for module-wide workflows, API, and setup.

Did you find this article useful?

Related Articles