Introdução
Tudo o que precisa para integrar a API Piloterr na sua aplicação.
Comece com a API Piloterr em minutos. Faça pedidos HTTP para os nossos endpoints e receba respostas JSON estruturadas.
Início rápido
Obtenha a sua chave de API
Registe-se no seu painel e copie a sua chave de API na página Definições.
Faça o seu primeiro pedido
Inclua a sua chave no cabeçalho x-api-key e chame qualquer endpoint:
curl "https://api.piloterr.com/v2/usage" \
-H "x-api-key: YOUR_API_KEY"Processe a resposta
Cada pedido bem-sucedido retorna um objeto JSON com dados estruturados. Consulte as páginas individuais de endpoints para esquemas de resposta e exemplos.
Autenticação
Todos os pedidos de API devem incluir um cabeçalho x-api-key. Pode encontrar a sua chave no seu painel > Chaves API.
curl -H "x-api-key: xxxx" https://api.piloterr.com/v2/usageMantenha a sua chave de API em segredo. Não a exponha em código do lado do cliente nem em repositórios públicos.
Códigos de estado
A cobrança aplica-se a pedidos bem-sucedidos: 200 para chamadas síncronas, 201 para trabalhos assíncronos. A cobrança do 404 varia por endpoint (verifique a página de cada endpoint). Todas as outras respostas 4xx/5xx são gratuitas.
| Código | Cobrado | Estado | Ação |
|---|---|---|---|
200 | Sim | Chamada de API bem-sucedida | Nenhuma ação necessária. |
201 | Sim | Trabalho criado | Nenhuma ação necessária. |
202 | Não | Aceite (assíncrono) | O pedido foi aceite e está a ser processado. Use o ID do trabalho para verificar o estado. |
400 | Não | Pedido incorreto | Verifique os seus parâmetros e os seus tipos. Consulte a documentação para mais informações. |
401 | Não | Chave de API inválida | Verifique a sua chave de API (cabeçalho x-api-key ou string de consulta x_api_key). |
401 | Não | Chave de API inativa | Ative a sua chave de API na secção Chaves API das Definições da sua conta. |
401 | Não | Chave de API expirada | Atualize a sua chave de API ou gere uma nova. |
401 | Não | Rate limit exceeded | Aguarde e tente novamente. Faça upgrade do plano ou aumente as cotas por chave se isso ocorrer com frequência. |
402 | Não | Payment required | Recarregue créditos, faça upgrade do plano, ative a Recarga automática ou quite as faturas em aberto. |
403 | Não | Proibido | Verifique as suas permissões. Contacte-nos se acredita que isso é um erro. |
404 | Varia | Não encontrado | A cobrança é específica de cada endpoint. Consulte a página do endpoint correspondente. |
413 | Não | Carga muito grande | O ficheiro enviado ou o corpo do pedido excede o limite de tamanho. Consulte a documentação para os tamanhos máximos. |
500 | Não | Erro interno | Repita a ação ou contacte a nossa equipa de suporte. |
Consulte a página de Créditos para um detalhe completo por endpoint, Chaves API para gestão de chaves, e Melhores práticas e Tratamento de erros para orientação de integração. Novo na plataforma? O Glossário define todos os termos principais.
Endpoints
Consulte cada endpoint na Referência da API, ou abra um diretamente: