App credentials (OAuth 2.0)

The authorization-code flow for apps that sign your customers in to Shout About Us — they enter their password on our page, your server gets a token.

The authorization-code flow for apps that sign your customers in to Shout About Us — they enter their password on our page, your server gets a token.

Prerequisites

  • A bearer token in the Authorization header. Any endpoint that needs no token says so on its own page.
  • The id of each record the call targets. Every endpoint page lists the ids it needs.

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

MethodEndpointDescription
GETStep 1: Send the user to sign inStep 1 — Authorize (browser redirect, documentation)
POSTStep 3: Exchange the code for a tokenStep 3 — Exchange code for token
GETRevoke a tokenRevoke token