Ana içeriğe geç
Version: 1.0

Netgsm İYS API

Bu API ile İleti Yönetim Sistemi'ne (İYS) izin kaydedebilir, kayıtlı izinleri sorgulayabilir ve izin sonuçlarının bildirileceği webhook adresinizi tanımlayabilirsiniz.

Kimlik doğrulama​

Her isteğe Authorization: Bearer <token> başlığını eklemelisiniz. Token'ı Netgsm Authorization API'nin POST /auth/v3/token ucundan, kullanıcı adınız ve şifrenizle alırsınız. Hesabınızda İYS hizmetinin aktif olması gerekir.

İstek ve yanıt biçimi​

  • Gövdeler JSON'dur: Content-Type: application/json.
  • Tarih ve saatler YYYY-MM-DD HH:mm:ss biçimindedir, örneğin 2026-02-20 16:46:00.
  • Telefon numaraları +90XXXXXXXXXX biçiminde, e-posta adresleri olduğu gibi gönderilir.
  • brandCode, İYS'deki marka kodunuzdur.

Her yanıt aynı zarfla döner:

{
"success": true,
"errorCode": 0,
"message": "success",
"data": {}
}

success işlemin başarılı olup olmadığını, errorCode sonucu gösterir; başarılı yanıtta errorCode 0'dır.

Her yanıtta X-Thread-Id başlığı döner. Destek ekibine yazarken bu değeri paylaşmanız, isteğinizi hızlıca bulmamızı sağlar. İsteğe kendi X-Request-Id değerinizi (8-64 karakter, A-Z a-z 0-9 . _ -) eklerseniz X-Thread-Id olarak bu değer kullanılır.

Hata kodları​

errorCodeHataHTTPAçıklama
50UNAUTHENTICATED401Kimlik doğrulama yapılmadı.
51TOKEN_NOT_FOUND401Token bulunamadı.
52INVALID_TOKEN401Geçersiz token.
53SESSION_EXPIRED401Token'ın süresi dolmuş.
60UNAUTHORIZED403Yetkisiz erişim.
61FORBIDDEN403Erişim engellendi.
63IYS_MODULE_INACTIVE403Hesapta İYS hizmeti aktif değil.
70VALIDATION_ERROR422İstekteki bir alan kurallara uymuyor; ayrıntı data.errors içindedir.
80METHOD_NOT_ALLOWED405Adres bu metodu desteklemiyor.
81NOT_FOUND404Kayıt bulunamadı.
112DEPENDENCY_ERROR424İYS'den geçerli bir yanıt alınamadı.
120BAD_REQUEST400Hatalı istek.
130CONFLICT409Kayıt zaten mevcut.
141INTEGRATION_ERROR503Servis şu anda isteği işleyemiyor; isteği biraz sonra tekrar gönderebilirsiniz.
150TOO_MANY_REQUESTS429Çok fazla istek gönderildi.
110SERVER_ERROR500Beklenmeyen bir hata oluştu.

Sunucu adresleri​

OrtamAdres
Canlı ortamhttps://ext-api.netgsm.com.tr/iys/v1

Authentication​

Authorization API'den aldığınız access token.

Security Scheme Type:

http

HTTP Authorization Scheme:

bearer

Bearer format:

JWT