REST API

İşler

Arka plan işlerini sorgulayın ve sonuçların tüm sayfalarını alın.

GET https://www.ninjabuy.com/api/v1/jobs/{id}, aynı hesabın bearer belirtecini gerektirir. Eksik, bilinmeyen veya başka hesaplara ait işler 404 döndürür.

Yaşam döngüsü

job.statusAnlamı
queuedBaşlamak için bekliyor.
runningİş sürüyor; yeni sonuçlar gelebilir.
doneİşleme tamamlandı. Her sonucun durumunu kontrol edin.
failedİş başarısız oldu. Varsa job.error değerini okuyun.

job; id, kind, status ve startedAt ile isteğe bağlı progress (done, total), finishedAt, result ve error alanlarını içerir. Zaman damgaları Unix başlangıcından bu yana geçen milisaniyelerdir. İş sıradayken veya çalışırken poll_after_seconds ve Retry-After başlığı ne kadar beklemeniz gerektiğini belirtir; ilk öneri 5 saniyedir.

Bağlantı gruplarında kind: "link_mints" bulunur. Son result; total, converted, failed ve isteğe bağlı campaign ile label değerlerini bildirir. Burada failed, dönüşüm yapılmadan yanıtlanan girdileri sayar; işin tamamının durumunun failed olduğu anlamına gelmez. E-tablo dönüştürmelerinde kind: "sheet_conversion" bulunur; son job.result, sayaçları ve imzalı XLSX indirme URL’sini içerir. İş şeması sheet_read, picture_copy ve resolution_run türlerini de kapsar.

İmleçle sayfalama

Yanıtta job, results, cursor, has_more ve request_id bulunur. Her sayfa giriş sırasıyla en fazla 50 sonuç içerir.

  1. İlk sayfada cursor göndermeyin (ofset 0).
  2. results değerini işleyin ve dönen null olmayan cursor değerini saklayın.
  3. has_more true olduğunda sonraki sayfayı ?cursor=RETURNED_CURSOR ile isteyin.
  4. İş sıradayken veya çalışırken has_more false ise poll_after_seconds kadar bekleyin ve sakladığınız imleçle yeniden sorgulayın. Sonradan yeni sonuçlar gelebilir.
  5. Yalnızca iş done veya failed olduğunda ve tüm sonuç sayfaları okunduğunda (cursor null olduğunda) bitirin.

İmleç, 1 ile 6 basamaklı (0 ile 999999) tek bir sorgu parametresi olmalıdır. Geçersiz veya yinelenen imleç parametreleri 400 döndürür. Yalnızca has_more: false değerini tamamlanma olarak değerlendirmeyin. curl örneklerine bakın.