Fácil de ler
Consulte endpoints, campos, exemplos, erros e respostas sem ler o código do servidor.
OPENAPI 3.0 · API DE PRODUÇÃO
Referência OpenAPI do URLZ
Explore todas as operações suportadas pela API URLZ, parâmetros, respostas e métodos de autenticação numa referência clara e legível por ferramentas.
OPENAPI
Um contrato fiável para cada integração
A descrição OpenAPI é o contrato técnico entre o URLZ e a sua aplicação. Utilize-a para compreender pedidos, validar respostas, importar a API ou gerar um cliente.
Legível por ferramentas
Importe o JSON no Postman, Insomnia, Swagger, Redocly ou num gerador de clientes.
Seguro desde a origem
Cada operação mostra a autenticação necessária. Mantenha os segredos no servidor.
QUICK START
Comece em quatro passos
- 1
Crie uma conta
Crie a conta URLZ e abra a área API da dashboard.
- 2
Escolha a autenticação
Use chave API no servidor ou sessão Bearer para funções da conta.
- 3
Envie um pedido
Copie um exemplo, substitua os valores e envie por HTTPS.
- 4
Trate a resposta
Verifique primeiro o estado HTTP e depois a resposta JSON.
API REFERENCE
Referência interativa completa
Pesquise a especificação e abra uma operação para ver parâmetros, corpo, exemplos e respostas.