Anonymous Token API Document

Overview

The Anonymous Token API allows clients to securely generate authorization tokens for users accessing the platform anonymously through web browsers and mobile applications (iOS and Android). This API facilitates secure interactions while maintaining user anonymity on all platforms.

API Endpoint

Request Type: Post

URL:

https://api.example.com/identity/anonymous-token

Query Parameters

The following query parameters are required for the API request:

Possible Platform Values

• web_browser: For users accessing via a web browser.

• iOS: For users accessing via iOS applications.

• Android: For users accessing via Android applications.

Request Headers

The following headers must be included in the request:

Request Examples

cURL Command

Web Example

curl --location 'https://api.example.com/identity/anonymous-token?site=example-site&platform=web_browser&deviceId=browser-unique_id_1234' \

--header 'Accept: application/json, text/plain, */*' \

--header 'x-api-key: a1b2c3d4e5f6g7h8i9j0k'

iOS Example

 curl --location 'https://api.example.com/identity/anonymous-token?site=example-site&platform=iOS&deviceId=app-unique_id_5678' \

--header 'Accept: application/json, text/plain, */w*' \

--header 'x-api-key: a1b2c3d4e5f6g7h8i9j0k'

Android Example

curl --location 'https://api.example.com/identity/anonymous-token?site=example-site&platform=Android&deviceId=app-unique_id_9012' \

--header 'Accept: application/json, text/plain, */*' \

--header 'x-api-key: a1b2c3d4e5f6g7h8i9j0k'

Responses

Successful Response

HTTP Status Code: 200 OK

Response Body:

{

"authorizationToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzaXRlIjoicHJvZC1leGFtcGxlIiwic2l0ZUlkIjoiMTIzNDU2Nzg5MCIsInVzZXJJZCI6IjEyMzQ1Njc4OTAiLCJpcGFkZHJlc3NlcyI6IjU0LjE3My4yMDAuMTQ4IiwiaWF0IjoxNjAwNjYxNDc3LCJleHBpcmF0aW9uIjoxNjAwNjY1MDc3fQ.S3krxMZgR7gQ03dZ3Z9Dq8P5gL3t4fD0zC9zQF5p5zM"

}

Error Response

HTTP Status Code: 400 Bad Request

Response Body:

{

"error": "Invalid parameters"

}

Common Error Codes

Important Notes

• API Key Security: The x-api-key is specific to each partner and must be kept confidential. Avoid exposing it in client-side code.

• Device ID Format: Ensure the deviceId is unique to prevent conflicts. Use a consistent naming convention:

  • For web: browser-{unique_identifier}

  • For iOS: app-{unique_identifier}

  • For Android: app-{unique_identifier}

• Token Validity: The authorizationToken is valid for a limited duration. Implement handling for token expiration in your application.