Testando a API

Use o playground da documentação para executar endpoints da API Spalla direto do navegador, com o seu token.

Cada página da Referência da API inclui um playground interativo: você configura os parâmetros, informa seu token e envia a requisição de verdade — sem escrever código.

Como usar

Abra a Referência da API e escolha um endpoint na barra lateral.

No playground do endpoint, preencha os path params, query params e o body (quando houver).

Em Auth, selecione o esquema bearerAuth e cole o seu token de API.

Confira a URL base (padrão: https://api.spalla.io) e clique em Send.

A resposta real da API aparece logo abaixo, com status HTTP, headers e corpo.

Ilustração do playground: endpoint, token e botão de enviar
O playground fica abaixo da descrição de cada endpoint.

Onde o meu token fica salvo?

Seu token é guardado somente no localStorage do seu navegador e enviado exclusivamente nas requisições que você disparar. A documentação não o armazena em servidores próprios.

Use um token de teste

Sempre que possível, teste com um token de uma conta de sandbox ou de desenvolvimento. Operações como DELETE afetam dados reais da conta vinculada ao token.

Entendendo as respostas

  • 2xx — sucesso; o corpo traz o recurso criado/consultado.
  • 401/403 — token ausente, inválido ou sem permissão para a operação.
  • 404 — recurso inexistente na conta do token.
  • 422 — validação falhou; o corpo descreve os campos com erro.

Consulte também o guia de Webhooks para reagir a eventos da API sem precisar fazer polling.

Nesta página