Authenticate with API Key

This page explains how to securely connect to our API using an API Key. It outlines the required authentication details and how to generate a digital signature to ensure safe and verified communicatio

Step by step

1. Create your user API Key and add permissions

   1. Create API KEY

2. Create a Signature

   1. Create a Signature

3. Authenticate via API

   1. Authenticate via API

Create API KEY

Navigate through the admin UI to your user profile.

Click on the API KEYS option.

Click on 'Create your API KEY'. You will see the following:

Depending on how you plan to use your API KEY, please choose from the available options. If you want to restrict usage by IP address, you can add the allowed IP in the designated field. Remember, you can always modify this later.

When you click on 'Create API Key', you will see your API KEY, API SECRET, and NONCE displayed on screen only once. You can download them using the 'Export to JSON' button. It's very important to store them in a safe place, as you will need them later.

To save, click the button confirming that you've securely stored your credentials, then close the modal. Your new API KEY will now appear in the list, and you can edit or delete it as needed.

Create a Signature

To generate a signature, you will need the API Secret, Nonce, User ID, and API Key, which are all generated, You can generate a signature by using a tool such as https://codebeautify.org/hmac-generator The algorithm will be SHA256, the Key will be the API Secret, and the plain text message will be composed of a combination the Nonce, User ID, and API key, in that exact order with no spaces. An example is listed below.

Authenticate via API

Follow the example in the image, add the APIKEY, Signature, UserId, and Nonce to the request headers, and call the AuthenticateUser endpoint. This will successfully authenticate you.

Authenticate user session

post

Body

one ofOptional

Responses

200

Authentication result

application/json

post

HTTPcURLJavaScriptPython

POST /ap/AuthenticateUser HTTP/1.1
Host: apstage.proxy.kiiex.io
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "APIKey": "text",
  "Signature": "text",
  "UserId": "text",
  "UserName": "text",
  "Nonce": "text"
}

200

Authentication result

{
  "authenticated": true,
  "user": {
    "userId": 1,
    "userName": "text",
    "email": "text",
    "emailVerified": true,
    "accountId": 1,
    "omsId": 1,
    "use2FA": true
  }
}

In the response, you will receive a session token. Use it in all subsequent requests by including it in the headers as the value of aptoken.