Authentication

Learn how to securely connect to the Neutron API

To use the Neutron API, you must first authenticate your requests using your API key and a digital signature. This process returns an access token which must be included in all subsequent requests.

Step 1: Generate Access Token

Endpoint: POST /api/v2/authentication/token-signature

Required Headers:

{
  "X-Api-Key": "your-api-key",
  "X-Api-Signature": "your-api-signature"
}

Successful Response:

{
  "data": {
    "accountId": "your-account-id",
    "accessToken": "your-access-token",
    "expiredAt": "2023-02-10T16:54:30.465018+07:00",
    "scope": "account.readWrite wallet.readWrite transaction.readWrite"
  }
}

• accessToken: This token is required for authenticating further API calls.

• expiredAt: The timestamp when the token will expire.

• scope: The permission level assigned to the token.

---

Step 2: Use Access Token in Subsequent Requests

Once authenticated, include the access token in the Authorization header for all other API requests:

Example Header:

{
  "Authorization": "Bearer your-access-token"
}

---

🛡️ Security Guidelines

• Keep your API key and signature secret. Never expose them in frontend code.

• Access tokens expire, so be prepared to re-authenticate when needed.

• Always use HTTPS to ensure encrypted communication.

• For development/testing, use sandbox credentials. Use live credentials only in production