Authorize applications

GET {{baseUrl}}/v2/oauth/authorize?client_id=<string>&redirect_uri=<string>&response_type=<string>&state=<string>

This endpoint returns a redirect URI (in the 'Location' header) that the customer uses to authorize your application and, together with POST /v2/oauth/access_token, generate an access token that represents that authorization.

Request Params

KeyDatatypeRequiredDescription
client_idstring(Required) Client ID (Consumer Key) of your application
realmstringUser type to be authorized (usually 'customer')
redirect_uristring(Required) The callback URI to send the request to after authorization; must use a host name that is registered with your application
response_typestring(Required) Type of temporary authorization code that will be used to generate an access code; the only valid value is 'code'
scopestringSpace-separated list of scopes to be authorized
statestring(Required) Unique value used by the calling app to verify the request

RESPONSES

status: OK

&quot;&quot;