Skip to Content
API ReferencePlayground Interativo

Playground Interativo

API Explorer

O Playground permite testar os endpoints da API diretamente no navegador, sem precisar de ferramentas externas como Postman ou cURL. Ele é o Swagger UI gerado pela própria API.

Como acessar

O playground completo está disponível em:

api.opero.global/api/docs 

A especificação OpenAPI em JSON fica em https://api.opero.global/api/docs-json.

Funcionalidades

Try It Out

  • Selecione qualquer endpoint no painel
  • Clique em “Try it out” e preencha os parâmetros (path, query, body)
  • Clique “Execute” para executar a requisição
  • Veja a resposta em tempo real

Autenticação no Playground

  1. Clique no botão “Authorize” (ícone de cadeado) no topo
  2. Cole seu Bearer Token (token de sessão)
  3. Todas as requisições subsequentes usarão essa credencial

O Swagger UI aceita apenas Bearer Token; não há campo para API Key.

Exemplo de código

Para cada requisição executada, o Swagger UI mostra o comando cURL equivalente.

Documentação inline

Cada endpoint mostra:

  • Descrição do que faz
  • Parâmetros de path e query
  • Schema do body, quando documentado (muitos endpoints não têm schema de body nem de resposta)

Dicas

Copie exemplos: O comando cURL e a resposta podem ser copiados — útil para criar mocks em testes.

Explore por módulo: Use os tags para navegar por área (Reservations, Financial, Guests, etc.).

Last updated on