Issue Token

Description#

Issue a new Access Token and Refresh Token with your API account credentials (username and password). Call this endpoint once when your integration starts, or again whenever the refresh token has expired.

API account credentials are not issued from the dashboard. Request them from contact@deeplyinc.com, and Deeply will send them to you by email.

Authentication#

This endpoint does not use an Authorization header. Send the API account credentials in the JSON request body.

Request Body#

Response Fields#

• access_token: Bearer token for normal API requests and WebSocket connections
• refresh_token: token used only with Reissue Token
• token_type: always Bearer
• expires_in: access token lifetime in seconds (3600 by default)

The refresh token is valid for 30 days by default.

Response#

{
  "access_token": "string",
  "refresh_token": "string",
  "token_type": "Bearer",
  "expires_in": 3600
}

Request Examples#

const response = await fetch('http://{{EDGE_IP}}:8100/api/v1/auth/token', {
  method: 'POST',
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "username": "api",
    "password": "YOUR_PASSWORD"
  })
});

const data = await response.json();