Developer DocumentationAdd your app to Setapp
API Reference

Redirection-based flow to obtain the authorization code

get
https://vendor-api.{domain}/auth/v1/authorize

The client should direct the user to the constructed URI using an HTTP redirection, or by other means available to it via the user-agent.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Value MUST be set to "code".

Allowed:
string
required

Client identifier received from Setapp.

scope
array of strings
required

The amount of access that should be granted to an access token. A list of space-delimited, case-sensitive strings. If the value contains multiple space-delimited strings, their order does not matter, and each string adds an additional access range to the requested scope.

scope*
string

Redirect URI the user should be redirected back to. If multiple redirect URIs were specified in the client's settings on Setapp Developer Account, the field is required and it should contain one of the the specified URIs.

string

An opaque value used by the client to maintain state between the request and callback. The authorization server includes this value when redirecting the user-agent back to the client. The parameter SHOULD be used for preventing cross-site request forgery.

string

Code challenge according to RFC7636.

string
enum
Defaults to plain

Code verifier transformation method. Defaults to plain.

Allowed:
Responses

429

Too many requests, try again later

500

Server error, try again later or contact the support team

Updated about 22 hours ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/json

Updated about 22 hours ago