SHshipsecai
integrations

POST /api/v1/integrations/{provider}/start

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/integrations/{provider}/start
  • Auth
    none declared

Path parameters

providerstring required

Request body

userIdstring required

Application user identifier to associate the connection with

redirectUristring required

Frontend callback URL that receives the OAuth code

scopesstring[]

Optional override of scopes to request

Response

providerstring required
authorizationUrlstring required
statestring required
expiresInnumber required

Suggested client-side TTL for the authorization URL

Example response

{
  "expiresIn": 300
}

Changes