API REST

Tarefas

Consulte o processamento em segundo plano e colete todas as páginas de resultados.

GET https://www.ninjabuy.com/api/v1/jobs/{id} exige o token bearer da mesma conta. Tarefas ausentes, desconhecidas ou de outras contas retornam 404.

Ciclo de vida

job.statusSignificado
queuedAguardando o início.
runningO processamento está em andamento; mais resultados podem chegar.
doneO processamento terminou. Confira o status de cada resultado.
failedA tarefa falhou. Leia job.error quando estiver presente.

job inclui id, kind, status e startedAt, além dos campos opcionais progress (done, total), finishedAt, result e error. Os horários são expressos em milissegundos desde o início da época Unix. Enquanto a tarefa estiver na fila ou em execução, poll_after_seconds e o cabeçalho Retry-After indicam quanto esperar; a sugestão inicial é de 5 segundos.

Lotes de links têm kind: "link_mints". Seu result final informa total, converted, failed e, opcionalmente, campaign e label. Aqui, failed conta as entradas respondidas sem conversão; isso não significa que o status da tarefa inteira seja failed. As conversões de planilhas têm kind: "sheet_conversion"; seu job.result final contém contagens e uma URL assinada para baixar o XLSX. O esquema de tarefas também contempla sheet_read, picture_copy e resolution_run.

Paginação por cursor

A resposta contém job, results, cursor, has_more e request_id. Cada página contém até 50 resultados na ordem de entrada.

  1. Omita cursor na primeira página (deslocamento 0).
  2. Processe results e guarde qualquer cursor retornado que não seja nulo.
  3. Quando has_more for true, solicite a próxima página com ?cursor=RETURNED_CURSOR.
  4. Se has_more for false enquanto a tarefa estiver na fila ou em execução, espere poll_after_seconds e consulte com o cursor guardado. Mais resultados podem chegar depois.
  5. Termine apenas quando a tarefa estiver done ou failed e todas as páginas de resultados tiverem sido lidas (cursor é null).

O cursor deve ser um único parâmetro de consulta com 1 a 6 dígitos (0 a 999999). Parâmetros de cursor inválidos ou repetidos retornam 400. Não interprete apenas has_more: false como conclusão. Veja os exemplos de curl.