OpenAPI ve Postman

OpenAPI belgesi

Her uç nokta, alan, şema ve webhook gövdesi bir OpenAPI 3.1 belgesinde tanımlıdır. API onu kendisi, her zaman güncel olarak sunar:

https://app.quatlasglobal.com/openapi/integrations-v1.json

Başvuru sayfalarının üretildiği kaynaktan alınmış bir kopyası burada:

integrations-v1.json

API başvurusu bu belgeden üretilir ve İngilizcedir.

Postman koleksiyonu

Aynı belgeden üretilmiş, her uç noktayı alanına göre gruplayan ve örnek gövdeler içeren bir Postman koleksiyonu (v2.1):

Postman koleksiyonu

1. Postman’de Import’u seçip dosyayı bırakın.
2. Koleksiyonun Variables sekmesinde apiKey değerine test anahtarınızı (qk_test_...) yazın. Belirteç isteği için clientId (anahtarın öneki) ve clientSecret (anahtarın kendisi) değerlerini girin. Bunları Postman’in paylaşmadığı ve eşitlemediği Current value sütununda tutun.
3. baseUrl değeri https://app.quatlasglobal.com. Her istek Authorization: Bearer {{apiKey}} gönderir; OAuth kullanmak için apiKey alanına erişim belirtecini koyun.
4. Oluşturma isteği her seferinde yeni bir X-Idempotency-Key ({{$guid}}) gönderir. Tekrarı denemek için oraya sabit bir değer yazın.

OpenAPI belgesini Postman’e doğrudan da alabilirsiniz (Import > Link); temel adresi https://app.quatlasglobal.com yapın.