İçeriğe geç
KuryeSoft

Kaynaklar

OpenAPI ve Postman

API'nin tamamı OpenAPI 3.1 biçiminde de yayımlanır: uçlar, alanlar, hata kodları, webhook gövdesi ve örnekler tek dosyada.

openapi.json

https://docs.kuryesoft.com,/openapi.json

İndir

Postman

  1. Postman'da Import → Link seçin ve https://docs.kuryesoft.com,/openapi.json adresini yapıştırın (ya da indirdiğiniz dosyayı sürükleyin).
  2. Oluşan koleksiyonun Variables sekmesinde sunucu adresini tutan değişkeni (genellikle baseUrl) kendi adresinizle değiştirin: https://kurye.firmaniz.com/api/v1.
  3. Koleksiyonun Authorization ayarında API Key türü (başlık: X-Api-Key) seçili gelir; değerine anahtarınızı yazın.

Insomnia ve diğer araçlar

Insomnia, Bruno, Hoppscotch ve Swagger UI dosyayı doğrudan içe aktarır. Sunucu adresi bir değişkendir (https://{host}/api/v1); host değerine kurye firmanızın alan adını yazın.

İstemci kodu üretmek

OpenAPI kod üreticileriyle kendi dilinizde hazır bir istemci üretebilirsiniz:

bash
# TypeScript türleri
npx openapi-typescript https://docs.kuryesoft.com,/openapi.json -o kuryesoft.d.ts

# Başka diller (Java, C#, Go, PHP, Python…)
npx @openapitools/openapi-generator-cli generate \
  -i https://docs.kuryesoft.com,/openapi.json -g csharp -o ./KuryeSoftClient
Bilgi:

Üretilen istemciler yalnızca istek ve yanıt biçimlerini bilir. Yinelenen gönderim, yeniden deneme ve webhook imza doğrulaması gibi davranışları bu belgelerdeki açıklamalara göre siz eklersiniz.

Dosyanın kapsamı

  • paths: entegrasyon API'sinin bütün uçları, istek gövdeleri, yanıtlar ve hata kodları.
  • webhooks: size gönderilen olay isteğinin başlıkları ve gövdesi.
  • components.securitySchemes: X-Api-Key başlığı ve Bearer biçimi.

Dosya bu belgelerle aynı kaynaktan üretilir; ikisi her zaman aynı sürümü anlatır.