Pular para o conteúdo principal

Use a API do OnStage

Troque suas credenciais da API por um token e chame a API do OnStage a partir dos seus próprios scripts e ferramentas.

Quem pode fazer isto: Proprietário, Administrador. O que significam as funções

Antes de começar​

Passos​

  1. Peça um token: envie POST https://api.on-stage.app/oauth/token com grant_type=client_credentials, usando seu ID do cliente e seu segredo como usuário e senha.
  2. Copie access_token da resposta. Ele dura uma hora.
  3. Envie-o em cada solicitação, no cabeçalho Authorization: Bearer <token>.
  4. Chame os endpoints em https://api.on-stage.app/integrations/v1. A referência da API mostra cada um, com o que enviar e o que volta.
  5. Quando o token expirar, peça um novo.

Vale saber​

  • Alterações em eventos e envios em massa só mostram uma prévia do que mudaria. Envie "dryRun": false para aplicá-las.
  • A API só pode fazer o que a sua função permite.
  • Cada equipe tem um número diário de solicitações, definido pelo plano. GET /integrations/v1/me mostra quantas restam.
  • Para gerar um cliente na sua linguagem, baixe o arquivo OpenAPI.

Artigos relacionados​