v1

latestOpenAPI 3.0.02026-07-131091452.6 MB

oauth

Authorize applications

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.

get/v2/oauth/authorize

Query parameters

client_idstring required

Client ID (Consumer Key) of your application

realm'customer' | 'contributor'

User 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_type'code' required

Type of temporary authorization code that will be used to generate an access code; the only valid value is 'code'

scopestring

Space-separated list of scopes to be authorized

statestring required

Unique value used by the calling app to verify the request