Oauth 2.0

This module implements an OAuth 2.0-style authorization flow, allowing third-party platforms to obtain delegated access to their customers' WorldFirst accounts. Once authorized, platforms can act on behalf of the customer within the granted permission scopes.
Important: This endpoint is available to approved partners only. Contact us at techsupport@worldfirst.com — our team is ready to assist you.

Endpoints

Authorization flow

  1. Redirect the customer to the WorldFirst authorization page using Authorize. The customer reviews and approves the requested permissions.
  1. WorldFirst redirects back to your
    redirectUri
    with an
    authCode
    (authorization code, valid for 10 minutes, single-use).
  1. Exchange the authorization code for an access token using Request a Token.
  1. Use the access token in API calls to act on behalf of the authorized account.
  1. Optionally refresh the access token using the refresh token before it expires.
  1. Revoke the access token when no longer needed using Revoke a Token.

Request headers

Send the headers required by your integration's authentication method. API Key authentication is suggested; see Authentication for both methods.

Scopes

Scopes follow the
resource:action
format and are space-separated when requesting multiple scopes. Supported values: