REST API

Taken

Vraag achtergrondtaken op en verzamel elke pagina met resultaten.

GET https://www.ninjabuy.com/api/v1/jobs/{id} vereist het bearertoken van hetzelfde account. Ontbrekende, onbekende en taken van andere accounts geven 404.

Levenscyclus

job.statusBetekenis
queuedWacht op de start.
runningDe verwerking loopt; er kunnen meer resultaten komen.
doneVerwerking voltooid. Controleer de status van elk resultaat.
failedDe taak is mislukt. Lees job.error als dit aanwezig is.

job bevat id, kind, status en startedAt, met optioneel progress (done, total), finishedAt, result en error. Tijdstempels zijn milliseconden sinds de Unix-epoch. Bij queued of running geven poll_after_seconds en de header Retry-After aan hoe lang je moet wachten; het eerste advies is 5 seconden.

Linkbatches hebben kind: "link_mints". Hun uiteindelijke result vermeldt total, converted, failed en optioneel campaign en label. Hier telt failed invoerwaarden die zonder omzetting zijn beantwoord; dit betekent niet dat de hele taak de status failed heeft. Spreadsheetconversies hebben kind: "sheet_conversion"; hun uiteindelijke job.result bevat tellingen en een ondertekende XLSX-download-URL. Het taakschema omvat ook sheet_read, picture_copy en resolution_run.

Paginering met cursors

Het antwoord bevat job, results, cursor, has_more en request_id. Elke pagina bevat tot 50 resultaten in invoervolgorde.

  1. Laat cursor bij de eerste pagina weg (offset 0).
  2. Verwerk results en bewaar elke geretourneerde cursor die niet null is.
  3. Vraag de volgende pagina op met ?cursor=RETURNED_CURSOR wanneer has_more true is.
  4. Als has_more false is terwijl de taak queued of running is, wacht dan poll_after_seconds en vraag opnieuw op met de bewaarde cursor. Later kunnen meer resultaten verschijnen.
  5. Stop pas wanneer de taak done of failed is en alle resultatenpagina's zijn gelezen (cursor is null).

Een cursor moet één queryparameter van 1 tot 6 cijfers zijn (0 tot 999999). Ongeldige of herhaalde cursorparameters geven 400. Beschouw alleen has_more: false niet als voltooiing. Zie de curl-voorbeelden.