Pular para o conteúdo
PT
Obter chave API
Explorar documentação

Referência da API

Erros e códigos de status

Ache a causa de um pedido fracassado e decida se consertará, esperará ou tentará novamente.

Nesta página

Códigos de status HTTP

Comece com o status HTTP, então leia o código de erro e a mensagem para a causa específica.

StatusO que quer dizer?O que fazer
400Pedido inválidoConserte a fonte, campos obrigatórios, tipos de parâmetros ou cabeçalhos de resposta antes de tentar novamente.
401A autenticação falhouVerifique X-API-Key. Substituir uma chave expirada ou revogada, tentar a mesma chave não vai ajudar.
402Créditos insuficientesVerifique o saldo da conta. Adicione créditos ou deixe o dono da conta resolver o acesso antes de enviar novamente.
403Acesso negadoVerifique as permissões da chave e o status da conta ou assinatura.
404Não encontradoVerifique o URL, o trabalho ID e a conta. trabalhos fora de sua conta ou fontes permitidas também podem devolver 404.
406Tipo de resposta não aceitávelUse Accept: application/json ou text/plain. Select Markdown com X-Respond-With: markdown.
409Resultado não pronto / conflitoEm um resultado lido, pesquise o trabalho existente até que ele termine. Para outros objetivos, resolva o conflito descrito no corpo.
410Resultado expiradoUse uma cópia salva. Tentando novamente o resultado URL não pode restaurar um resultado expirado.
422Entrada inválida / tarefa falhadaConserte os campos relatados. Em uma leitura de resultado, inspecione job.error: um trabalho fracassado não tem nenhum resultado bem sucedido para buscar.
429Limite atingidoEspere por Retry-After ou retry_after. Reduza a taxa de solicitação; para uma fila pendente, aguarde os trabalhos existentes para finish.
500 / 502 / 503 / 504Serviço ou falha de montanteTente ler novamente com o limite. Para um intervalo POST ou submissão, verifique se o trabalho foi aceito antes de enviá-lo novamente.

Leia uma resposta de erro

Erros API usam JSON, inclusive quando você pede texto simples. O corpo difere pelo ponto final. Ramo no status e código HTTP quando presente, use mensagem ou detalhes para explicar o problema.

Erros de consulta geralmente incluem erro e mensagem; código é opcional. Erros de autenticação podem usar success: false em vez de error: true.

400 · application/json
{
  "error": true,
  "code": "unsupported_representation",
  "message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}

Inspecione status, cabeçalhos e corpo

Use curl --include para ver todos os três. Este exemplo verifica sua chave com uma conta livre lida; ela não envia uma consulta. Coloque FLASHDATA_API_KEY em seu ambiente primeiro.

Inspecione uma resposta. cURL / Bash
curl --include --silent --show-error --max-time 20 \
  'https://api.flashdata.dev/v2/api-access/identity' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Quando tentar novamente

Uma repetição do POST pode criar outra consulta. Um tempo limite não prova que o primeiro pedido foi rejeitado. Salve o trabalho ID assim que receber.

SituaçãoPróxima ação
Entrada, chave, permissão ou equilíbrio inválidosPare. Conserte o pedido ou o estado da conta antes de tentar de novo, não perca tempo com esses erros.
429 com uma dica de esperaHonor Retry-After (segunda data ou data HTTP), ou o valor JSON retry_after em segundos. Se ambos estiverem presentes, use o atraso mais longo.
Pedido de leitura: 429 / erro temporário de rede 5xxTente novamente o mesmo GET. Sem uma dica de espera, use atrasos crescentes com nervosismo, uma contagem máxima de tentativas e um limite de tempo.
POST tempo limite ou 5xxx ambíguoMantenha o trabalho existente ID e verifique seu status. Se nenhum ID foi recebido, inspecione o histórico de trabalho antes de decidir se submeter novamente.

verificação um trabalho de fundo

HTTP 200 do ponto final do estado significa que a leitura foi bem sucedida. Verifique job.status para saber se a tarefa foi bem sucedida. Defina JOB_ID para o seu trabalho existente; este comando não envia uma substituição.

job.statusO que fazer
pending / processingEspere, então pesquise o mesmo trabalho. Um resultado lido retorna 409 até a conclusão.
completedRecupere e salve o resultado. Os resultados originais do JSON retornam um redirecionamento de armazenamento 302; os resultados formatados retornam um corpo diretamente.
failedPare de fazer pesquisas e inspecione job.error. O resultado final devolve 422 com código result_not_ready para um trabalho fracassado.
Leia status do trabalho · cURL / Bash
curl --fail-with-body --silent --show-error --max-time 30 \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Erros de formatação de resposta

Status / códigoConsertar
400 · unsupported_representationColoque X-Respond-With para marcar, ou remova o cabeçalho.
406 · not_acceptableDefina Accept para application/json ou text/plain; use UTF-8 se especificar uma codificação.

Consiga ajuda com um pedido

Envie o endpoint, horário de UTC, status HTTP, código de erro e solicitação ou trabalho ID. Remova as chaves API, fichas e assinou URLs do relatório.