ConverterHQDevelopers
API v1

API kuralları

API v1 için HTTP, ID, sayfalama, zaman ve ortak header kuralları.

Sağlam entegrasyonlar endpoint ayrıntılarından çok status, opaque ID, cursor ve request metadata için istikrarlı kurallara dayanır.

HTTP ve durum kodları

Asenkron create işlemleri sürerken 202 Accepted, başarılı read işlemleri 200 döner. Hatalar Problem Details ve istikrarlı machine code kullanır.

ID ve zaman

file_..., job_..., task_... ve project_id değerlerini opaque string olarak görün. Timestamp ISO 8601 UTC’dir; ID sırasından anlam çıkarmayın.

Cursor sayfalama

Listeler opaque cursor kullanır. next_cursor değerini değiştirmeden gönderin, filtreleri koruyun ve client tarafında cursor üretmeyin.

Operasyon header’ları

Replay edilebilir create işlemlerinde Idempotency-Key gönderin ve X-Request-ID saklayın. Retry öncesi Retry-After ve RateLimit-* değerlerine uyun.