AUTHENTICATION

Generate Token

Public partner-facing reference for authentication, property setup, content retrieval, and calendar synchronization endpoints.

Summary

Audience Connectivity partners and integration teams
Authentication Use the generate-token endpoint to obtain a Bearer token for protected endpoints.
Format All examples are illustrative and may use sample IDs, names, and dates.
Scope Only the external API contract is documented; internal implementation details are intentionally omitted.

General Authentication

All protected endpoints in this document should be called with the header Authorization: Bearer , unless the endpoint explicitly states that authentication is not required. Tokens are obtained through the token-generation endpoint documented below. If a token is missing, malformed, expired, or invalid, the request should be considered unauthorized and rejected by the service.

Authentication and Token Generation

Use this endpoint to obtain a token that is later sent as a Bearer token in authenticated connectivity requests.

Method POST
Endpoint /generateToken
Authentication No authentication documented for this endpoint.
Response type application/json

Description

This endpoint generates a token for a provisioned channel user. During onboarding, credentials are issued to the partner. The partner can then call this endpoint with those credentials to obtain a token that remains valid for a limited time and can be used in subsequent authenticated API calls.

Request

Content-Type: application/x-www-form-urlencoded

Authentication: Not required for this endpoint.

Field Type Description
Username String Assigned channel username.
Password String
/UUID		 Assigned channel password.

Example Request

POST /generateToken?username=channel_user&password=550e8400-e29b-41d4-a716-446655440000

Response

This endpoint returns plain text.

Field/Value Type Description
<generated
_token>		 String New token value returned when the provided credentials are valid
invalid username or password String Returned when the supplied credentials do not match a provisioned user.
token expired String Returned when token generation is not allowed for the current account state.

Example Response

eyJhbGciOiJIUzI1NiJ9.example.token

Notes

  • Credentials are provisioned during onboarding rather than self-registered through the API.
  • This endpoint is used to obtain the token that is sent in later authenticated requests.
  • The returned token should be sent as Authorization: Bearer in later requests that require authentication.
  • Partners should refresh tokens before expiry to avoid interrupted connectivity calls.