API REST

Operazioni

Interroga le operazioni in background e recupera tutte le pagine di risultati.

GET https://www.ninjabuy.com/api/v1/jobs/{id} richiede il token bearer dello stesso account. Le operazioni assenti, sconosciute o appartenenti ad altri account restituiscono 404.

Ciclo di vita

job.statusSignificato
queuedIn attesa di avvio.
runningElaborazione in corso; possono arrivare altri risultati.
doneElaborazione terminata. Controlla lo stato di ogni risultato.
failedL'operazione non è riuscita. Leggi job.error se presente.

job include id, kind, status e startedAt, oltre ai campi facoltativi progress (done, total), finishedAt, result ed error. I timestamp sono millisecondi dall'inizio dell'epoca Unix. Durante l'attesa o l'esecuzione, poll_after_seconds e l'header Retry-After indicano quanto attendere; il suggerimento iniziale è di 5 secondi.

I batch di link hanno kind: "link_mints". Il loro result finale indica total, converted, failed e, facoltativamente, campaign e label. Qui failed conta gli input a cui è stata data una risposta senza conversione; non significa che lo stato dell'intera operazione sia failed. Le conversioni di fogli hanno kind: "sheet_conversion"; il loro job.result finale contiene conteggi e un URL firmato per scaricare il file XLSX. Lo schema delle operazioni comprende anche sheet_read, picture_copy e resolution_run.

Paginazione con cursore

La risposta contiene job, results, cursor, has_more e request_id. Ogni pagina contiene fino a 50 risultati nell'ordine degli input.

  1. Ometti cursor per la prima pagina (offset 0).
  2. Elabora results e conserva qualsiasi cursor non nullo restituito.
  3. Quando has_more è true, richiedi la pagina successiva con ?cursor=RETURNED_CURSOR.
  4. Se has_more è false durante l'attesa o l'esecuzione, attendi poll_after_seconds, poi interroga con il cursore conservato. Altri risultati possono arrivare in seguito.
  5. Termina solo quando l'operazione è done o failed e tutte le pagine di risultati sono state lette (cursor è null).

Il cursore deve essere un unico parametro di query da 1 a 6 cifre (da 0 a 999999). Parametri del cursore non validi o ripetuti restituiscono 400. Non interpretare il solo has_more: false come completamento. Consulta gli esempi curl.