Token

Overview

The Token endpoint is used to obtain an authorization token for a Partner's client.

The main objectives of the Token method are:

Authentication: It verifies the identity of the Partner using the provided credentials, ensuring that only authorized Partners can access the API.

Authorization: It issues an access token that serves as proof of authorization. This token must be included in subsequent API requests to validate the Partner's access rights.

Security: It enhances communication security by generating a token that has a defined lifespan and may include additional details such as token type and scopes. This minimizes the risk of unauthorized or stale access.

Access Control: It facilitates proper access management by potentially associating specific permissions or scopes with the token. This ensures that Partners only have access to the API functionalities necessary for their operations.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

ErroreCode

number

required

Error code of the response.

Message

string

required

Code description.

Value

object

optional

Token parameters.

id_token

string

optional

Identification token.

access_token

string

required

Access token.

expires_in

number

required

Token lifetime in seconds.

token_type

string

required

Toke type.

refresh_token

string

optional

Refresh token

scope

string

required

Access rights granted to the token.

Examples

Example 1Example 1

{
    "ErrorCode": 200,
    "Message": "Success",
    "Value": {
        "id_token": null,
        "access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkQyNTk5NTU5REMxNkI5NkZGNkU5OTI2NkQ2MTdBMDgyQjk2MjdDNUEiLCJ0eXAiOiJKV1QiLCJ4NXQiOiIwbG1WV2R3V3VXXzI2WkptMWhlZ2dybGlmRm8ifQ.eyJuYmYiOjE2MjYyNjM1NTAsImV4cCI6MjEyNjI2MzU1MCwiaXNzIjoiaHR0cHM6Ly90dmJldGFwaXByb3h5LnRvcC9pZGVudGl0eS1hcGkiLCJhdWQiOlsiaHR0cHM6Ly90dmJldGFwaXByb3h5LnRvcC9pZGVudGl0eS1hcGkvcmVzb3VyY2VzIiwiZXh0ZXJuYWwtY2xpZW50LWFwaSIsImZlZWRzLWFwaSIsInNpZ25hbHItZmVlZC1hcGkiXSwiY2xpZW50X2lkIjoiUGFydG5lckNsaWVudC0xNTU2Iiwicm9sZSI6IlBhcnRuZXJDbGllbnQiLCJwYXJ0bmVyX2NsaWVudF9pZCI6IjE1NTYiLCJzY29wZSI6WyJleHRlcm5hbC1jbGllbnQtYXBpIiwiZmVlZHMtYXBpIiwic2lnbmFsci1mZWVkLWFwaSJdfQ.sSwkKQxwthFEAjQSw6ccIUgJ-ziGIzT8aDKfDZT5AusWGSzt8U-VOcn33g9GOs_Zl1MG2fmysByAv94ACeDEzvWMQwQnVScz2StObiJmTMwbXyDU7qHkV6HaLtNuXs0hIwG6rv91Zu1hjhAOFOmoi1-YYWNg5xnK57JYOqCQ5n0OHXY6PwwgB7kPaQpPZkHX3YgLE1lJWaBHH1r8bDk-4d_CQaWT1a0tFnJvIuOpf4bDcpZsiNtpzusc4yrQ0zBxXxeYlEx3Nbhp_oGxVN2i4WgPh9i6LJm33XH0pmtrUP-OnKkQS6wy0jHOHyGQ81cHHjkyOzsUR_tHpWxB_Tc1GAFF6uKeXO-GiOWBRkZEJ2Id5vuR1X741D5arzESVhOIkRKJmjUAMQcm_QnhlLB8Qpl08tFft8KjtZHMZx050c1Eyto9OYvTf_WhH9fuuqUU8SVieJYYoXloXZ3_igEi6_DHyg_8XN1wojd1UXnTHuWakBEkOb34W0svReKtMogKAM2Td07KtM0VKLBvvXe5VmQrtK8cnR20vwtbJhhRZIj4WQYUuYr9Y9BU71WQZIpU4b2BHlNWO6D1He48h1-KoJB3zMHhWmnbQCLvGf3fMSoRXEMpOLxLU5D8Hb1sRWWj5ptAWOCcNNYIcIiOnm9Cux5cRN4Hk8-R-HiLVpumYMo",
        "expires_in": 500000000,
        "token_type": "Bearer",
        "refresh_token": null,
        "scope": "external-client-api feeds-api signalr-feed-api"
    }
}

⚪103752Incorrect request parameters

Overview#

Request

Request samples

Responses

Overview