Access Token

In order to authorize your API calls, you will need an access token. For security, the only way to programmatically obtain an access token is by exchanging it for an API key. Learn how to:

Exchange API key for access token

post

Exchange an API key for an oAuth2 access token

Body

apiKeystringRequired

The actual API key that you have received from the API key request.

Example: eyJjcnYiOiJQLTM4NCIsImQiOiJyM1VFQ21naUNiNjI1c19CZWc3emdULUlCajJUOUZW...

Responses

200

A successful response.

tokenstringOptionalExample: eyJjcnYiOiJQLTM4NCIsImQiOiJyM1VFQ21naUNiNjI1c19CZWc3emdULUlCajJUOUZW...

expiresInstring · int64OptionalExample: 3600

scopestringOptional

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

post

/access_token

POST /v1/auth/access_token HTTP/1.1
Host: api.bytenite.com
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "apiKey": "eyJjcnYiOiJQLTM4NCIsImQiOiJyM1VFQ21naUNiNjI1c19CZWc3emdULUlCajJUOUZW..."
}

{
  "token": "eyJjcnYiOiJQLTM4NCIsImQiOiJyM1VFQ21naUNiNjI1c19CZWc3emdULUlCajJUOUZW...",
  "expiresIn": "3600",
  "scope": "text"
}

User signout

post

Log out current user and invalidates token

Authorizations

AuthorizationstringRequired

Your ByteNite access token

Body

objectOptional

Responses

200

A successful response.

okbooleanOptional

True if the request was successful.

requestIdstringOptional

Internal request identifier for tracing or support.

Example: xyz-123

messagestringOptional

Additional message providing status or context.

Example: Request failed

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

post

/signout

POST /v1/auth/signout HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}

Check if the user is already logged in

get

Check if the user is already logged in, if the user can skip login a redirect url is returned

Authorizations

AuthorizationstringRequired

Your ByteNite access token

Query parameters

loginChallengestringOptional

Responses

200

A successful response.

skipbooleanOptional

redirectTostringOptional

400

Returned when the users sends a malformed request.

401

Returned when the user is not authenticated.

403

Returned when the user does not have permission to access the resource.

404

Returned when the resource does not exist.

500

Returned when an error on the server occurred.

503

Returned when the resource is temporarily unavailable.

default

An unexpected error response.

get

/skip

GET /v1/auth/skip HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "skip": true,
  "redirectTo": "text"
}

PreviousAuthentication API NextAPI Keys

Last updated 10 months ago

Was this helpful?

hashtagExchange API key for access token

hashtagUser signout

hashtagCheck if the user is already logged in

Exchange API key for access token

User signout

Check if the user is already logged in