Authentication

To access our services, you need to be both authenticated and authorized. The first step is to generate an access token. This token is essential for secure interaction with our API and ensures that only authorized users can access the services.

Credentials for Token Generation

To create your access token, you will need the following credentials, which were provided to you via email:

• Key: A unique identifier for your application.

• Username: Your assigned username.

• Password: The corresponding password for your username.

How to Authenticate

Send Your Key as a Header: Include your key in the request header under the field Authorization-Key.

Use Basic Authorization for Username and Password: Combine your username and password into a Basic Authorization header. This involves encoding the username:password pair using Base64.

POST Create JWT token

Creates a new JWT session token

post

Creates a new JWT session token

Authorizations

Basic Auth

AuthorizationstringRequired

Enter your username and password

Header parameters

x-api-keystringRequired

Your credential's unique identifier key

x-pvt-timezonestringOptional

Your timezone

Responses

201

A new JWT session token has been created successfully

application/json

tokenstringRequiredExample: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

expires_atnumberRequired

Datetime when this token will expired

Example: 946702800000

400

Your request metadata or your payload contains incorrect values

application/json

401

Unauthorized access due to invalid credentials, invalid or expired JWT token

application/json

403

Your key, your credentials or your JWT token are invalid, or you don't have access for this resource

application/json

500

An unexpected error has been raised durig this process

application/json

post

/business/v1/auth

HTTPcURLJavaScriptPython

POST /business/v1/auth HTTP/1.1
Host: api.mio.id
Authorization: Basic username:password
x-api-key: text
Accept: */*

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
  "expires_at": 946702800000
}