Exchange OAuth grants for opaque access tokens - Vantr Developer Docs

POST

/

oauth

/

token

Exchange OAuth grants for opaque access tokens

curl --request POST \
  --url https://api.vantr.ai/oauth/token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/x-www-form-urlencoded'

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({})
};

fetch('https://api.vantr.ai/oauth/token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vantr.ai/oauth/token"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

{
  "access_token": "<string>",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "products.read categories.read vendors.read locations.read",
  "refresh_token": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

Authorizations

Authorization

string

header

required

Use client_id as username and client_secret as password for confidential server-side calls. The application allowed_scopes still gate each /v2 endpoint; never use this secret in browsers, mobile apps, logs, or query strings. Server integrations may alternatively send x-client-id and x-client-secret headers (the legacy x-invoiceedge-* names remain accepted).

Body

application/x-www-form-urlencoded

grant_type

enum<string>

required

Available options:

client_credentials,

authorization_code,

refresh_token

scope

string

Required for client_credentials and authorization_code requests. Optional on refresh_token to narrow the refreshed access token.

Example:

"products.read categories.read vendors.read locations.read"

code

string

redirect_uri

string<uri>

code_verifier

string

refresh_token

string

Response

Opaque bearer token response.

access_token

string

required

token_type

string

required

Example:

"Bearer"

expires_in

integer

required

Example:

3600

scope

string

required

Example:

"products.read categories.read vendors.read locations.read"

refresh_token

string

Exchange OAuth grants for opaque access tokens

curl --request POST \
  --url https://api.vantr.ai/oauth/token \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/x-www-form-urlencoded'

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({})
};

fetch('https://api.vantr.ai/oauth/token', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vantr.ai/oauth/token"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

{
  "access_token": "<string>",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "products.read categories.read vendors.read locations.read",
  "refresh_token": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}

{
  "error": "<string>",
  "error_description": "<string>"
}