Registering a Client

The Phoenix API uses Open Authorization 2.1 (OAuth 2.1) to manage secure access to its resources.

OAuth 2.0/2.1 is a widely-adopted authorization protocol enabling third-party applications to securely access user resources on a service without exposing user credentials, such as usernames and passwords. OAuth is commonly employed to securely connect different platforms, allowing users to grant limited access from one service (e.g., Google or Facebook) to another application (e.g., social media management or financial tools) without sharing sensitive login details.

Phoenix Client Registration Process

Before accessing the Phoenix API, your application must first register as a Client. Please follow these steps to register:

Step 1: Raise a Zendesk Ticket

To begin the registration process for your client application, submit a Zendesk ticket with the following information clearly provided:

• Client Name: A unique, descriptive name for your application.

Step 2: Receive Your Client Credentials

Once the registration is approved, you'll receive credentials containing the following:

{
  "AuthServerUrl": "https://fslpresales.fslcgix-uat.co.uk/fslpresales_AuthServer",
  "ClientName": "MyClientName",
  "ClientId": "9AA75B11-CBFC-4445-8FB4-514403C296AE",
  "ClientSecret": "OUFBNzVCMTEtQ0JGQy00NDQ1LThGQjQtNTE0NDAzQzI5NkFF"
}

• AuthServerUrl: Endpoint URL to initiate OAuth authorization and token requests.
• ClientName: The name assigned to your application during registration.
• ClientId: A unique identifier assigned to your registered client, used during authorization requests.
• ClientSecret: A confidential secret used alongside your ClientId for authentication when requesting tokens. It must be stored securely and not exposed publicly.