Authentication

Request an Access Token

This endpoint issues an OAuth access token via an HTTP POST request. The token remains valid for 60 minutes. After expiration, you must request a new token.

Available Scopes and their access

ScopeDescription
packages:readRead packages information
applications:readRead access to applications
applications:writeWrite access to applications
subscriptions:readRead access to subscriptions
subscriptions:writeWrite access to subscriptions (subscribe/updated/delete)
post/oauth/token

Request

  • Base URL
    https://sandbox.signup.nmi.com/api/v1
  • URL
    https://sandbox.signup.nmi.com/api/v1/oauth/token
  • Auth
    none required

Request body

grant_type'client_credentials' required

The OAuth2 grant type (e.g., client_credentials).

client_idstring required

Client Key identifier

client_secretstring required

Client Secret

Response

Successful response with the Access Token

token_typestring required

The type of token (typically Bearer).

expires_ininteger required

The lifetime of the token in seconds.

access_tokenstring required

The access token used to authenticate requests to protected resources.

Example response

{
  "expires_in": 3600
}

Changes

No recorded changes to this operation across all 1 revision of this API.