Skip to main content

Initial authentication with API Key

Summary

  • Creates an access token which can be used throughout the process
  • companyId is required
  • Required API calls: authenticationService/authenticate

Request

Request to https://apis.alfaview.com/json/v1/authenticationService/authenticate

{
  "requestId": "### REQUEST ID ###",
  "authorizationCodeCredentials": {
  "clientId": "### API KEY ALIAS ###",
  "code": "### API KEY SECRET ###",
  "companyId": "### COMPANY ID ###"
  }
}

Response

{
  ...
  "accessToken": "...",
  "expiresAt": "...",
  ...
}

Notes

  • Store the access token for subsequent requests
  • Remember to re-authenticate before expiresAt timestamp, or you will receive an error that the token has expired

Last updated on July 3rd, 2025, 11:38 am