Geliştirici API'si
Araçları tarayıcıya bağlı kalmadan kendi yazılımından çağır: bir istek gönderir, işi başlatır ve çıktıyı indirirsin. Bütün uçlar tek bir sürümlü adreste toplanır; her istek kişisel bir anahtarla yetkilendirilir.
İş akışı
Bir çağrı dönüştürme işini başlatır ve sana bir iş kimliği verir. Kimlikle işin durumunu sorgular, tamamlandığında çıktıyı indirirsin. İşler uzun sürebildiği için bu ayrım istemcinin akışı bloke etmeden beklemesini sağlar.
Anahtar ve erişim
İstekler Authorization: Bearer başlığıyla imzalanır. Anahtarını hesabından üretir, dilediğin an iptal edebilirsin; düz metin anahtar yalnızca üretildiği an gösterilir. Tarayıcı oturumu burada kimlik yerine geçmez.
API yüzeyi açık araçlar
| Araç | API yüzeyi | Doküman |
|---|---|---|
| KargoLabel | Dönüştürücü — POST /run | Doküman |
| Gelir-Gider Defteri | 10 uç (durum tutan app) | Doküman |
| GörselKüçült | Dönüştürücü — POST /run | Doküman |
| PdfSplit | Dönüştürücü — POST /run | Doküman |
Sürüm ve sözleşme
Uçlar https://api.pixepi.com altında /api/v1 ile sürümlenir; geriye dönük uyumsuz bir değişiklik yeni bir sürüm gerektirir. Makine-okur sözleşme OpenAPI 3.1 olarak yayımlanır ve doğrudan istemci üreteçlerine verilebilir.
Yanıt ve hatalar
Yanıtlar JSON zarfındadır; her iş kendi kimliğiyle sorgulanır ve kayıtların kime ait olduğu sunucuda denetlenir. Bir sorun oluştuğunda yanıt, durumu anlatan bir kod döndürür; istemci bu kodu kendi diline çevirir.
Ayrıntıya geçiş
- Seçtiğin aracın sayfasındaki API bağlantısı; o aracın uçlarını, istek alanlarını, seçeneklerini ve hata davranışını açar.
- Makine-okur sözleşme: OpenAPI belgesi.
- Merkezî geliştirici sayfası: tüm uçların ortak listesi.