API da Vixpi Portal de desenvolvedores, versão v1

Painel do desenvolvedor

Changelog da API

O que mudou na API. Dentro da v1 a Vixpi só acrescenta campos, rotas e escopos; uma mudança que quebre o seu código sai numa versão nova da URL.

Lançamento da API v1

A API que o painel usa passa a aceitar tokens de terceiros, com escopos e documentação pública.

  • OAuth 2.1: Fluxo authorization code com PKCE S256, refresh com rotação e revogação. O emissor publica o discovery em /.well-known/openid-configuration.
  • Chaves pessoais: Chaves vxp_ criadas no painel, com os escopos e a validade que você escolher.
  • Escopos: Cada rota exige um escopo (por exemplo tickets:read). Rota sem escopo na tabela não aceita token.
  • Webhooks: Eventos de serviços, faturas e tickets, assinados com HMAC-SHA256 e com retentativas por até 24 h.
  • Limite de uso: Cada token tem 60 requisições por minuto. Acima disso a API responde 429 com Retry-After.
  • Especificação: OpenAPI 3.1 em /api/v1/openapi.json e referência interativa no portal.