AUTHENTICATION

Get 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 get-token endpoint to obtain a 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 <token>, 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 /getToken
Authentication No authentication required for this endpoint.
Response type text/plain

Description

This endpoint validates the provided username and password against the stored channel credentials. When the credentials are valid, it returns the token associated with that channel user. That token can then be used in later authenticated API calls.

Request

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

Authentication: Not required for this endpoint.

Field Type Description
username String Channel username used to identify the partner account.
password String Channel password associated with the provided username.

Example Request

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

Response

This endpoint returns plain text.

Field/Value Type Description
<token> String Token returned when the provided username and password match an existing channel user.
Channel manager not found RuntimeException Thrown when no channel user matches the supplied credentials.

Example Response

eyJhbGciOiJIUzI1NiJ9.example.token

Notes

  • The endpoint is mapped to /getToken.
  • The method expects username and password as request parameters.
  • On success, the returned token should be sent in the Authorization: Bearer <token> header for subsequent requests that require authentication.
  • If no matching channel user is found, the request should be treated as unauthorized.