Webhook kaydetme ve güncelleme

POST 
/webhooks

İstek: POST https://ext-api.netgsm.com.tr/iys/v1/webhooks
Canlı ortam: https://ext-api.netgsm.com.tr/iys/v1

İYS'ye yüklediğiniz izinlerin işlenme sonuçlarının ve izin değişikliklerinin bildirileceği adresi tanımlar. Marka için daha önce bir adres tanımlandıysa yenisiyle değiştirilir.

Request

application/json

Bodyrequired

brandCodeintegerrequired
İYS marka kodu.
Possible values: >= 1 and <= 2147483647
Example: 123456
pathIysPath (string)nullable
Gönderilmezse SMSAPI kabul edilir.
Possible values: [SANTRAL, SMSAPI, WEBPORTAL]
Example: SMSAPI
webhookUrlurirequired
Bildirimlerin gönderileceği adres.
Example: https://example.com/webhook

Responses

200

Webhook adresi kaydedildi.

application/json

Schema

Schema

successboolean
Example: true
errorCodeinteger
Example: 0
messagestring
Example: success
data object
uidstring
Example: ee5c7e61-3940-432a-af30-13b0c9944371

Example (auto)

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": {
    "uid": "ee5c7e61-3940-432a-af30-13b0c9944371"
  }
}

Example

{
  "success": true,
  "errorCode": 0,
  "message": "success",
  "data": {
    "uid": "ee5c7e61-3940-432a-af30-13b0c9944371"
  }
}

400

Hatalı istek.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": []
}

401

Token yok, geçersiz ya da süresi dolmuş.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

expired

Token'ın süresi dolmuş

{
  "success": false,
  "errorCode": 53,
  "message": "Token has expired",
  "data": []
}

notFound

Token bulunamadı

{
  "success": false,
  "errorCode": 51,
  "message": "Token not found",
  "data": []
}

403

Yetkisiz erişim ya da hesapta İYS hizmeti aktif değil.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 60,
  "message": "Unauthorized access",
  "data": []
}

422

İstekteki bir alan kurallara uymuyor.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 70,
  "message": "Validation failed",
  "data": {
    "errors": {
      "brandCode": "The brand code field is required."
    }
  }
}

424

İYS'den geçerli bir yanıt alınamadı.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 112,
  "message": "Api Error",
  "data": []
}

429

Çok fazla istek gönderildi.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 150,
  "message": "Too many requests.",
  "data": []
}

500

Beklenmeyen bir hata oluştu.

application/json

Schema

Schema

successboolean
Example: false
errorCodeinteger
Hata kodu (bkz. Hata kodları).
Example: 120
messagestring
Example: Bad request
data object
Hata ayrıntıları. Çoğu hatada boş dizidir; doğrulama hatasında errors nesnesini taşır.
oneOf
MOD1
Array [
]
MOD2
object

Example (auto)

{
  "success": false,
  "errorCode": 120,
  "message": "Bad request",
  "data": [
    null
  ]
}

Example

{
  "success": false,
  "errorCode": 110,
  "message": "Server Error",
  "data": []
}

Örnek istek

curl -X POST 'https://ext-api.netgsm.com.tr/iys/v1/webhooks' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "brandCode": 123456,
  "path": "SMSAPI",
  "webhookUrl": "https://example.com/webhook"
}'