Registered APIs

You can register external endpoints that you want the platform to invoke on your behalf using the Registered APIs feature, found under Admin › Developer › Registered APIs. A registered API captures the base URL and authentication for a system you own, so that custom scripts and Cloud Functions can call it without embedding credentials in configuration.

The Registered APIs list: each row shows the name, base URL, and auth type. Register New API lives at the top right.

Register a new API

Click Register New API at the top-right corner of the page and configure the details:

  1. Registered API Name — a name for your registered API.
  2. Base URL — the base URL of the API to call.
  3. Is Read Only — enable if you want this registered API to be read-only. Note that the API will no longer be editable once it's been saved as read-only.
  4. Headers — header names and values needed by your API (e.g. name: Authorization; value: Bearer {token}).
  5. Authorization — the auth type and its parameters:
Auth typeParameters
API KeyKey Name, Key Value, Add to 'Header' or 'Query Params'
BasicUsername and Password
Bearer TokenBearer Token
None
OAuthGrant Type, Access Token URL, Client ID, Client Secret, Scope, Send as 'Basic Auth Header' or 'Request Body'
A registered API's Details: name, base URL, and the Is Read Only toggle — irreversible once saved. The Authorization section configured for OAuth with client credentials. The client secret is write-only after saving.

Once you have configured your registered API and its authorization credentials, click Save. It is now available to be called from custom scripts and Cloud Functions.


Did this page help you?