İYS API - TELSAM | Toplu SMS | Sabit Telefon | Sanal (Bulut) Santral

TELSAM İYS RESTAPI

Adres: http://iys.telsam.com.tr/api/v1

Body içerik tipi: application/json

Parola için yetkilendirme jetonu alma

Tanımlar

Kimlik doğrulama için Jeton Alma metodu çağırılarak bir adet erişim jetonu (“access token”) ve yenileme jetonu (“refresh token”) alınır. username, password, client_id ve client_secret değerleri arayüzde oluşturulan api kullanıcısına ait değerlerdir.

(HTTP METHOD: POST)

grant_type: “password”
username: API kullanıcı adınız
password: API kullanıcı şifreniz
client_id: API client id’si
client_secret: API client secret

				
					http://iys.telsam.com.tr/api/v1/oauth/token

Örnek İstek

				
					{
    "grant_type" : "password",
    "username": kullanıcı adı,
    "password": şifre,
    "client_id": client id,
    "client_secret": client secret
}

Örnek Başarılı Yanıt

				
					HTTP STATUS CODE: 200

{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiYmUxNmRiMmEzNmY0M2NlNTdkNTNhOWIxYWFkYmNiODBmMDcyYTE0OWVmYWM1NmZmMDk3OTNhYWE3MDcyMzVjNTNiM2QyZGYxNDc4YWU4NDciLCJpYXQiOiIxNjE0NjA1MTg2LjMwODcxNCIsIm5iZiI6IjE2MTQ2MDUxODYuMzA4NzE5IiwiZXhwIjoiMTY0NjE0MTE4Ni4wNjcwNjAiLCJzdWIiOiIxOSIsInNjb3BlcyI6W119.hfWEsbiV2DCYvytrewq-5OIdsTPqBOmJebPeqgY0aPGY1Ky7ngLgPmyQvh4oztuVU5Chzj0fGI7SiuwwDOnmkDBipfDIGv1IcJA7mPoAxZ2EBBAwlgs7YIcemEhJOKgYCcVIUB8NAYCgMGpozqAEI4Zyz1bR5G8GcfUIyhEAKm2Ky0_m04jCBZ6efGSecCGU4qLWZMLRUsGcQTaUNVefi7l5bB4wkHFUveLbjywXXnGhFr_Q94M1KbHX2XzC3AYwxaP2zqja_Us78KO1jgII66eSLZ9fczHO0EruKd0J8e4KVl1d8qU0pu5rIPM-VCsxjXfRMVq7t6xTAeTp7MchOZOgQ7DDBCq6OAFt4t7T5CY4E3NSiUqJOSsctvKyv9xX_oPd1cRqe7CT_Pw0aOmNHaYQk1J1U8aZBKszeFg7S4KR-426bj-DMvuDoVjJF1yIPIliUrC9cLkwynmjdBbUomf3TPvujOaVMqFDmcyz8Brk074tbj9VXmxcO9YidT12OPJMXlEcIzlDMlQaI3Dax6i_Ngfz8i_q-crzdiA46x95MkMgP0HRPcBBAdjjlYSvjw3IEj1EhUN6uQUAQcZ6xsujq56MtE2SzOtc6_h0-gM5vbEvEpOo-osuh06vAFqAeouQm_faCqON6pfNGFWAH-R7vWVZYyfqE6kbMQXb_to",
    "refresh_token": "def50200b7484d580082e42439b4934c0ca9aeab07c83530df0707d90cc641b868e850342a5903f91bd57e7829a172e705d74a4afee34452731e8dc18bef2e3012a719edce95afc5e412b915047602478ecfc47cab13f565570920555a0d8d5a6c8331a33d5f94fec2d11099cada9d9309eb3118f61b38f25a17c40fdd6ae86faabcceaeb920460d4a1fd2b28a837975adbb853266458fee1d44683cb932684b2c5d678497f766a408bdf18fa32ea595b1f833cbc8e4cd010b9b4639a53cd777271dc5d73b51d5d9707107da8114aad92e6c7912f852863fe36c8df85d46d25dbcb2e7c27f905679669ee63c821fd7406e7bcc993222c3640b84adb15ba807ada8ebc1367bc6792ed47dad94b171f17539985d9b5d1097ecf0d3c32f3c48699c255ee16bcb88d87c89dafbf9b4e713eda5cb4824bca4bf6be2c51e2ed6b5cb1f75dd78766efaa8dabf378720eb119e38d0f82661729939deb6b6e204a62da196"
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 400

{
    "error": "unsupported_grant_type",
    "error_description": "The authorization grant type is not supported by the authorization server.",
    "hint": "Check that all required parameters have been provided",
    "message": "The authorization grant type is not supported by the authorization server."
}

				
					HTTP STATUS CODE: 401

{
    "error": "invalid_client",
    "error_description": "Client authentication failed",
    "message": "Client authentication failed"
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Unknown Error"
}

Oauth2 yetkilendirme jetonu alma

Aşağıdaki verilen görsellerdeki aşamalar izlenerek “code” oluşturulur.

Daha sonra, jeton alma metodu çağırılarak bir adet erişim jetonu (“access token”) ve yenileme jetonu (“refresh token”) alınır. client_id, client_secret, redirect_uri değerleri arayüzde oluşturulan api kullanıcısına ait değerlerdir. Code, kullanıcının girmiş olduğu yönlendirilecek url vasıtasıyla oluşturulmuş değerdir.

				
					http://iys.telsam.com.tr/api/v1/oauth/token

Tanımlar

(HTTP METHOD: POST)

grant_type: “authorization_code “
client_id: API kullanıcı id’si
client_secret: API anahtarı
redirect_uri: code’un oluşturulduğu uri
code: redirect_uri aracılığıyla oluşturulan code

Örnek İstek

				
					{
    "grant_type"     : "authorization_code",
    "client_id"         : 1,
    "client_secret" : "z3Kewxm2K6H4stFslvJHqx7kvzasiDKvsvIBQnaX",
    "redirect_uri" : "https://example.com/callback",
    "code" :   "def50200213698b36c6c7e6f3ff5eca3f01e476c31fe50db0f0f70e740f71397f3338a6f84c934ab72652041612f4b0fe5965c1706964cb3ba84d9c9afe92a4ba086670163efc97813eec6c9e4884de1843e1f6eac5786363bdafc6c00d50830ddee16b882cc0b107542166f17e8974397dc035173126d35768db9d6d7dff6a3d4d461636c4c77a2262db99cce6c3f23807222b848e2d060efb2d9284bc06064dd44452fe7891bbe002a6bda19547028433d64321a888b178690bb4ec5a2b4879e7e58c74ad9536ddc37496c798a7b27be7c8afaea53aa81ff49d492486bdb80eff03f8d473cc3fa64204018d81e9a02b5e1236f044bc1548d588df4fde9e5264c7542b282391dabc51e9df61e5e77b50a1582d107d6ebf04c2b45131b12179c65d141f6dd4713d053d58d6cb6d7a9e8ec0c83c9a011b98f0d7ab5e4ff8a801842932be9c941df6ff9c46f9e86ea"
	}

Örnek Başarılı Yanıt

				
					HTTP STATUS CODE: 200

{
    "token_type": "Bearer",
    "expires_in": 31536000,
    "access_token":   "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIzIiwianRpIjoiZGU3OTk0OWZhOGMzMTU0NGMxYzZlN2U5MDhjM2M0MGY4ZGNhMzAwYmU2YTJmNDliZDA5Yjg0ZmM0NGNkMjNiMmIwY2MyNWI5MWZhkjabdjkafıuw65654646wwhyeyegzNzMiLCJzdWIiOiIiLCJzY29wZXMiOltdfQ.kUek0SiXT3XPFW92ho3rT1WRi3LzP9nLXV5QlFbIrQTbL18mwbQLZ6bGw6ss82VkxKa-orQfV0NIRJorhj8RZbnOz2XPHZDh-59o0znctyo-fhZqsPQP55Cjwa3cFRVRbDXORDESsOoxd38nIzbL2jPk8bk3eaLdmMWGu3uolctN4uQ7_9XxWJZlZIJ4OHbS3JtDX9Z00PG9M9SuM6qbBowTXq4OkCeRIvJaAn88Hr8jBjyc0fnawok4e_sGBaDFpmEAd-3UqSxOZ5Rwytb8VyHfWk-Pm-E6asRr_kyjcXtgE8vzl6_BPHAR2_VV2pCF27MJm9bXGDedygp6tHAkaMg780J4oj9IPPWi5fd0CygeeLsvjiqo6EMrBGZ_y0QL2jLdQ28aIyAoVFNZ1L19Ki7b9R9YNWgeW_izkaenVY6-ptVGzfPo3R5gW4cOihu5pdEbndcmFIjmV5Y87KzO5DcnRM_z0gQn6HwpiBCIkYNyYzjII7nJDKZgg1nu3Lf6MaTxeffIC5RrsLS9OeOKVSf0-xSZryzkzn7o-BmaQjMk9pkRqr2d29z2i4D0ToCXkSFG8uOUb-32U6zbIXsFpgfEk01pjf7zXA76ZbVEf19hrCHyeXSX5kFmWoqEIEI89Go0z7bsb1EqkXOgqxI8mDwgELAcWAULO9B8xK3didU",
"refresh_token": "def50200d995385b392f69f200657d3593d274375fa9c515bae8b3af214934cb975b2a06666ab4bafc8edeffd59cb00932947f3a89a7a81fd9922375692d3aa9c2fae5cda16d33a31df9b8569777432dfc313886a9e78231df1b47ada8a5f9d2a25f5276f29448e409e7df2dedfd126b937b915fdd662c2b7eae068adec416d6c6f85c5aa7d17ae0276c21e729695cb78c4cb5cc67943d613c55412f592efe50d78b9bc231b768373e3070470a978eb91f3206297fb588391cffe371cdad7af4a5864b21f1e30f6bb46bf8f6b41be9a8d36ac362461251b92189a6fc26e5c73a6d80b7456b7786207ac23c366b55fa03aff2d6aed504b4cefeb19f92c2cf57a5e3ee79dfe12b0818f0770f0598e9f78bac5ba33ac8d8cec00f5ee9b316102619b2fefc8923330f1cd4bb95539a6cdf6118effe5df3ed477155e43a39c32a2c530237a7adec391de050a72349e8d1f06d00b7d690bf1dd4ed313500021c6879d5e6"
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 400

{
    "error": "unsupported_grant_type",
    "error_description": "The authorization grant type is not supported by the authorization server.",
    "hint": "Check that all required parameters have been provided",
    "message": "The authorization grant type is not supported by the authorization server."
}

				
					HTTP STATUS CODE: 401

{
    "error": "invalid_client",
    "error_description": "Client authentication failed",
    "message": "Client authentication failed"
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Unknown Error"
}

Tekil izin ekleme

Tek bir iznin kaydedilmesi için kullanılan metottur.

				
					http://iys.telsam.com.tr/api/v1/permission/{brandCode}

(HTTP METHOD: POST)

brandCode: 6 haneli firmaya özel marka kodu

type: Enum: “ARAMA” “MESAJ” “EPOSTA”
source: Enum: “HS_FIZIKSEL_ORTAM” “HS_ISLAK_IMZA” “HS_WEB” “HS_CAGRI_MERKEZI” “HS_SOSYAL_MEDYA” “HS_EPOSTA” “HS_MESAJ” “HS_MOBIL” “HS_EORTAM” “HS_ETKINLIK” “HS_2015” “HS_ATM” “HS_KARAR”

Vatandaşın izin durumu belirlediği kaynaktır. Alıcı tipi TACIR ise eklenmesi zorunlu değildir.

recipient: Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir. E-posta adresleri 265, telefon numaraları 15 karakterden daha uzun olamaz. Telefon numaraları E164 uluslararası([+][country code][area code][local phone number]) formata uygun olmalıdır.

status: Enum: “ONAY” “RET” Vatandaşın izin durumunu gösterir.

consent_date: İznin, vatandaştan alındığı tarihtir. Formatı YYYY-MM-DD HH:mm:ss şeklinde olmak zorundadır. Recipient_type TACIR ise eklenmesi zorunlu değildir.

recipient_type: Enum: “BIREYSEL” “TACIR” İzin kaydının tacir veya bireysel amaçla alındığını ifade eder.

Örnek İstek

				
					{
    "type": "MESAJ",
    "source": "HS_WEB",
    "recipient": "+905554442211",
    "status": "ONAY",
    "consent_date": "2021-02-23 22:20:06",
    "recipient_type": "BIREYSEL"
}

Örnek Başarılı Yanıt

				
					HTTP STATUS CODE: 200

{
    "id": 1,
    "request_status": "Pending",
    "total": 1
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 422

{
    "message": "The given data was invalid.",
    "errors": {
        "recipient_type": [
            "The recipient type field is required."
        ]
    }
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Tekil İzin Sorgulama

Tekil izin ekleme metodu kullanılarak kaydedilmiş izinlerin detayına ulaşmak için kullanılan metottur.

				
					http://iys.telsam.com.tr/api/v1/permission/{id}

(HTTP METHOD: GET)

id: Tekil izin ekleme başarılı yanıtında gelen id değeri

Başarılı Yanıt (Pending)

				
					{
    "request_status": "Pending"
}

Başarılı Yanıt (Completed)

				
					HTTP STATUS CODE: 200

{
    "id": 1,
    "request_status": "Completed",
    "permission": {
        "type": "MESAJ",
        "source": "HS_WEB",
        "recipient": "+905554442211",
        "status": "ONAY",
        "consent_date": "2021-02-23 22:20:06",
        "recipient_type": "BIREYSEL"
    },
    "iys_response": {
        "creation_date": 2021-02-23 22:20:06,
        "transaction_id": "hkagdkahflakgjagdakklulkqehof56v16a43a2jk",
        "status": "success",
        "message": null
    }
}

Başarılı Yanıt (Skipped)

				
					HTTP STATUS CODE: 200

{
    "id": 1,
    "request_status": "Skipped",
    "permission": {
        "type": "MESAJ",
        "source": "HS_WEB",
        "recipient": "+90555442211",
        "status": "ONAY",
        "consent_date": "2021-02-23 22:20:06",
        "recipient_type": "BIREYSEL"
    },
    "iys_response": {
        "creation_date": null,
        "transaction_id": null,
        "status": "failure",
        "message": "Sistemdeki iznin tarihinden önceki tarihli izinlerle güncelleme yapılamaz"
    }
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Çoklu izin ekleme

Birden çok iznin kaydedilmesinde kullanılan metottur.

				
					http://iys.telsa.com.tr/api/v1/permissions/{brandCode}

(HTTP METHOD: POST)

brandCode: 6 haneli firmaya özel marka kodu

Vatandaşın izin durumu belirlediği kaynaktır. Alıcı tipi TACIR ise eklenmesi zorunlu değildir.
recipient: Vatandaşın sistemde kayıtlı telefon numarası veya e-posta bilgisidir. E-posta adresleri 265, telefon numaraları 15 karakterden daha uzun olamaz. Telefon numaraları E164 uluslararası([+][country code][area code][local phone number]) formata uygun olmalıdır.

status: Enum: “ONAY” “RET” Vatandaşın izin durumunu gösterir.
consent_date: İznin, vatandaştan alındığı tarihtir. Formatı YYYY-MM-DD HH:mm:ss şeklinde olmak zorundadır. Recipient_type TACIR ise eklenmesi zorunlu değildir.

recipient_type: Enum: “BIREYSEL” “TACIR” İzin kaydının tacir veya bireysel amaçla alındığını ifade eder.

Örnek İstek

				
					[
  {
    "type": "MESAJ",
    "source": "HS_WEB",
    "recipient": "+905554442211",
    "status": "ONAY",
    "consent_date": "2021-02-25 09:45:02",
    "recipient_type": "BIREYSEL"
  },
  {
    "type": "ARAMA",
    "source": "HS_WEB",
    "recipient": "+905556667788",
    "status": "RET",  
    "consent_date": "2021-02-25 09:45:03",
    "recipient_type": "TACIR"
  },
  {
    "type": "MESAJ",
    "source": "HS_MESAJ",
    "recipient": "+905551234567",
    "status": "ONAY",
    "consent_date": "2021-02-25 09:45:03",
    "recipient_type": "BIREYSEL"
  }
]

Örnek Başarılı Yanıt (Pending)

				
					HTTP STATUS CODE: 200

{
    "id": 11,
    "request_status": "Pending",
    "total": 3
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 422

{
    "message": "The given data was invalid.",
    "errors": [
        [
            "The 0 field is required."
        ]
    ]
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Çoklu izin sorgulama

Çoklu izin ekleme metodu ile kaydedilmiş izinlerin detayına ulaşmak için kullanılan metottur.

				
					http://iys.telsam.com.tr/api/v1/permissions/{id}

id: Çoklu izin ekleme başarılı yanıtında gelen id değeri

Örnek Başarılı Yanıt (Pending)

				
					HTTP STATUS CODE: 200

{
    "request_status": "Pending"
}

Örnek Başarılı Yanıt (Completed)

				
					{
    "id": 11,
    "request_status": "Completed",
    "0": [
        {
            "permission": {
                "recipient": "+905554442211",
                "recipient_type": "BIREYSEL",
                "type": "MESAJ",
                "source": "HS_WEB",
                "consent_date": "2021-02-25 09:45:02",
                "status": "ONAY"
            },
            "iys_response": {
                "creation_date": "2021-02-25 09:45:02",
                "transaction_id": "qazxwedcvfrtgb675234hdhad",
                "status": "success",
                "message": null
            }
        },
        {
            "permission": {
                "recipient": "+905556667788",
                "recipient_type": "TACIR",
                "type": "ARAMA",
                "source": "HS_WEB",
                "consent_date": "2021-02-25 09:45:03",
                "status": "RET"
            },
            "iys_response": {
                "creation_date": "2021-02-25 09:45:03",
                "transaction_id": "lsdkowwdcvfrtgb675234hdh45",
                "status": "success",
                "message": null
            }
        },
        {
            "permission": {
                "recipient": "+905551234567",
                "recipient_type": "BIREYSEL",
                "type": "MESAJ",
                "source": "HS_MESAJ",
                "consent_date": "2021-02-25 09:45:03",
                "status": "ONAY"
            },
            "iys_response": {
                "creation_date": "2021-02-25 09:45:03",
                "transaction_id": "oyrtrnrgf454564jofhslkd",
                "status": "success",
                "message": null
            }
        }
    ]
}

Örnek Başarılı Yanıt (Skipped)

				
					{
    "id": 11,
    "request_status": "Completed",
    "0": [
        {
            "permission": {
                "recipient": "+905554442211",
                "recipient_type": "BIREYSEL",
                "type": "MESAJ",
                "source": "HS_WEB",
                "consent_date": "2021-02-25 09:45:02",
                "status": "ONAY"
            },
            "iys_response": {
                "creation_date": "2021-02-25 09:45:02",
                "transaction_id": "qazxwedcvfrtgb675234hdhad",
                "status": "success",
                "message": null
            }
        },
        {
            "permission": {
                "recipient": "+905556667788",
                "recipient_type": "TACIR",
                "type": "ARAMA",
                "source": "HS_WEB",
                "consent_date": "2021-02-25 09:45:03",
                "status": "RET"
            },
            "iys_response": {
                "creation_date": "2021-02-25 09:45:03",
                "transaction_id": "lsdkowwdcvfrtgb675234hdh45",
                "status": "success",
                "message": null
            }
        },
        {
            "permission": {
                "recipient": "+905551234567",
                "recipient_type": "BIREYSEL",
                "type": "MESAJ",
                "source": "HS_MESAJ",
                "consent_date": "2021-02-25 09:45:03",
                "status": "ONAY"
            },
            "iys_response": {
                "creation_date": "2021-02-25 09:45:03",
                "transaction_id": "oyrtrnrgf454564jofhslkd",
                "status": "success",
                "message": null
            }
        }
    ]
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Günlük izin özet sorgulama

Günlük olarak yapılan izin hareketlerinin istatiksel detayını getiren metottur.

				
					http://iys.telsam.com.tr/api/v1/agreement/{brandCode}/summary/{reportDate}/{recipientType}

(HTTP METHOD: GET)

brandCode: 6 haneli firmaya özel marka kodu

reportDate: Y-m-d formatlı tarih

recipientType: BIREYSEL ya da TACIR

Örnek Başarılı Yanıt

				
					HTTP STATUS CODE: 200

[
    {
        "type": "ARAMA",
        "permissions": [
            {
                "source": "HS",
                "approval": 10,
                "rejection": 1,
                "pending": 0,
                "total": 11
            }
        ]
    },
    {
        "type": "MESAJ",
        "permissions": [
            {
                "source": "HS",
                "approval": 38,
                "rejection": 2,
                "pending": 1,
                "total": 41
            }
        ]
    },
    {
        "type": "EPOSTA",
        "permissions": [
            {
                "source": "HS",
                "approval": 5,
                "rejection": 2,
                "pending": 3,
                "total": 10
            }
        ]
    }
]

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Günlük izin bilgisi sorgulama

Günlük olarak yapılan izin hareketlerinin mutabakat detayına ulaşmak için kullanılan metottur.

				
					http://iys.telsam.com.tr/api/v1/agreement/{brandCode}/information/{reportDate}

(HTTP METHOD: GET)

brandCode: 6 haneli firmaya özel marka kodu

reportDate: Y-m-d formatlı tarih

Örnek Başarılı Yanıt(agreementStatus=true)

				
					HTTP STATUS CODE: 200

{
    "processStatus": "completed",
    "hashValue": "ada7d721b9a920499e8305a8c8ac3e6afb276826bd240fe9c8820e5722082996",
    "hashMethod": "SHA-256",
    "agreementStatus": "true"
}

Örnek Başarılı Yanıt(agreementStatus=false)

				
					{
    "processStatus": "completed",
    "hashValue": "ada7d721b9a920499e8305a8c8ac3e6afb276826bd240fe9c8820e5722082996",
    "hashMethod": "SHA-256",
    "agreementStatus": "false"
}

Yanıt Tanımları

İşlem Durumu (processStatus): Hash verisinin üretim durumunu ifade eder.

Tamamlandı (completed): Devam Ediliyor (inprogress) ve Hata (error) değerlerini alabilir.

Mutabakat Bilgisi (hashValue): İlgili markanın talep edilen tarihte gerçekleşen günlük izin değişimi dökümünün hash değerine dönüşmüş halini ifade eder.

Veri Metodu (hashMethod): Hash veri üretmek üzere kullanılan SHA256 algoritmasını ifade eder.

Mutabakat Durumu (agreementStatus): İYS ile hizmet sağlayıcının ilgili markası arasında belirtilen tarihteki izin hareketleri için mutabakat sağlanıp sağlanmadığının bilgisidir.

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Günlük hareket dosyası

Günlük olarak yapılan izin hareketlerinin tamamına ulaşmak için kullanılan metottur.

				
					http://iys.telsam.com.tr/api/v1/agreement/all/{brandCode}/{reportDate}

(HTTP METHOD: GET)

brandCode: 6 haneli firmaya özel marka kodu

reportDate: Y-m-d formatlı tarih

Örnek Başarılı Yanıt

				
					2020-12-01 00:10:37,12345678aee8e7229080b997147556ca7bb89a3c48c6fc844bf3e9a63e03fd15,+905552223344,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00,HS_FIZIKSEL_ORTAM
2020-12-01 00:10:37,134589662f7ae8a2d8944afca3e3e1e1e56a59fe79fd089423148a521378e, +905552223333,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00,HS_FIZIKSEL_ORTAM
2020-12-01 00:10:37,iuyadfl64d7692b71e99b565a356329fe053066e1cda54005a4ac776a5, +905552223322,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00,HS_FIZIKSEL_ORTAM
2020-12-01 00:10:37,aaaaaaaf504bd4a57e8f6d32af8a98e03acd689fb203c6bbdd27cbbc075d6, +905552223388,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00,HS_FIZIKSEL_ORTAM

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Agreement CSV File Not Found!"
}

Diğer günlük hareket dosyası

Günlük sistem dışından yapılan izin hareketlerine ulaşmak için kullanılan metottur.

				
					http://iys.telsam.com.tr/api/v1/agreement/other/{brandCode}/{reportDate}

(HTTP METHOD: GET)

brandCode: 6 haneli firmaya özel marka kodu

reportDate: Y-m-d formatlı tarih

Örnek Başarılı Yanıt

				
					2020-12-01 00:10:37,12345678aee8e7229080b997147556ca7bb89a3c48c6fc844bf3e9a63e03fd15,+905552223344,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00,IYS_WEB
2020-12-01 00:10:37,134589662f7ae8a2d8944afca3e3e1e1e56a59fe79fd089423148a521378e, +905552223333,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00, IYS_WEB
2020-12-01 00:10:37,iuyadfl64d7692b71e99b565a356329fe053066e1cda54005a4ac776a5, +905552223322,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00, IYS_WEB
2020-12-01 00:10:37,aaaaaaaf504bd4a57e8f6d32af8a98e03acd689fb203c6bbdd27cbbc075d6, +905552223388,BIREYSEL,MESAJ,ONAY,2020-01-01 00:00:00, IYS_WEB

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Agreement CSV File Not Found!"
}

Günlük mutabakat onaylama

Günlük olarak yapılan izin hareketlerinin tamamı için mutabakat onayı göndermeyi sağlayan metottur.

				
					http://iys.telsam.com.tr/api/v1/agreement/approval/{brandCode}/{reportDate}

(HTTP METHOD: GET)

brandCode: 6 haneli firmaya özel marka kodu

reportDate: Y-m-d formatlı tarih

approval: Onay parametresi(Boolean değer gönderilecektir)

Örnek İstek

				
					{
   	 "approval" : true
}

Örnek Başarılı Yanıt

				
					HTTP STATUS CODE: 200

{
    "success": "Mutabakat Bilgisi Kaydedildi"
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 422

{
    "error": "approval can only be boolean true"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

İys Yolu Onay Alma İşlemi Başlatma

İys aracılığıyla izin ekleme işleminin başlatılmasını sağlayan metottur. İstek atıldıktan sonra 180 saniye içinde iys yolu onay alma işlemi tamamlama metodunun kullanılarak işlemin tamamlanması gerekmektedir. Günlük aynı kullanıcı için maksimum 2 tane istek gönderilebilir. Başarılı bir istek gönderildiğinde kullanıcıya doğrulama kodu (verification_code) gönderilir.

				
					http://iys.telsam.com.tr/api/v1/iys-path/{brandCode}/start

(HTTP METHOD: POST)

brandCode: 6 haneli firmaya özel marka kodu

type: Enum: “ARAMA” “MESAJ” “EPOSTA”

source: Onay istemek için alıcıya doğrulama kodunun iletileceği kanal bilgisidir. (Enum: IYS_KISAMESAJ IYS_CM IYS_EPOSTA)

• IYS_KISAMESAJ: Alıcıya kısa mesajla doğrulama kodu iletililir. type alanının [“MESAJ”] veya [“ARAMA”, “MESAJ”] olması durumunda kullanılabilir.
• IYS_CM: Alıcı aranarak doğrulama kodu iletilir. type alanının [“ARAMA”] veya [“ARAMA”, “MESAJ”] olması durumunda kullanılabilir.
• IYS_EPOSTA: Alıcıya e-postayla doğrulama kodu iletilir. type alanının [“EPOSTA”] olması durumunda kullanılabilir.

recipient_type: Enum: “BIREYSEL” “TACIR” İzin kaydının tacir veya bireysel amaçla alındığını ifade eder.

Örnek İstek

				
					{
  "recipient": "+905556667788",
  "recipient_type": "BIREYSEL",
  "type": [
    "ARAMA", "MESAJ"
  ],
  "source": "IYS_KISAMESAJ"
}

Örnek Başarılı Yanıt

				
					HTTP STATUS CODE: 200

{
  "transactionId": [
    "ag573c4bf59ee973bs62c173a4d147dfaa3248ke38cf8u0f767lm22251ece1ty"
  ],
  "creationDate": "2020-11-11 16:50:54"
}

Örnek Başarısız Yanıtlar

				
					HTTP STATUS CODE: 401

{
    "message": "Unauthenticated."
}

				
					HTTP STATUS CODE: 403

{
    "message": "This action is unauthorized."
}

				
					HTTP STATUS CODE: 404

{
    "message": "Not Found!"
}

				
					HTTP STATUS CODE: 500

{
    "message": "Server Error"
}

Cookie	Duration	Description
cookielawinfo-checbox-analytics	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Analytics".
cookielawinfo-checbox-functional	11 months	The cookie is set by GDPR cookie consent to record the user consent for the cookies in the category "Functional".
cookielawinfo-checbox-others	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Other.
cookielawinfo-checkbox-necessary	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookies is used to store the user consent for the cookies in the category "Necessary".
cookielawinfo-checkbox-performance	11 months	This cookie is set by GDPR Cookie Consent plugin. The cookie is used to store the user consent for the cookies in the category "Performance".
viewed_cookie_policy	11 months	The cookie is set by the GDPR Cookie Consent plugin and is used to store whether or not user has consented to the use of cookies. It does not store any personal data.

TELSAM İYS RESTAPI

Parola için yetkilendirme jetonu alma

Tanımlar

Örnek İstek

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

Oauth2 yetkilendirme jetonu alma

Tanımlar

Örnek İstek

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

Tekil izin ekleme

Örnek İstek

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

Tekil İzin Sorgulama

Başarılı Yanıt (Pending)

Başarılı Yanıt (Completed)

Başarılı Yanıt (Skipped)

Örnek Başarısız Yanıtlar

Çoklu izin ekleme

Örnek İstek

Örnek Başarılı Yanıt (Pending)

Örnek Başarısız Yanıtlar

Çoklu izin sorgulama

Örnek Başarılı Yanıt (Pending)

Örnek Başarılı Yanıt (Completed)

Örnek Başarılı Yanıt (Skipped)

Örnek Başarısız Yanıtlar

Günlük izin özet sorgulama

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

Günlük izin bilgisi sorgulama

Örnek Başarılı Yanıt(agreementStatus=true)

Örnek Başarılı Yanıt(agreementStatus=false)

Yanıt Tanımları

Örnek Başarısız Yanıtlar​

Günlük hareket dosyası

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar​

Diğer günlük hareket dosyası

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

Günlük mutabakat onaylama

Örnek İstek

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

İys Yolu Onay Alma İşlemi Başlatma

Örnek İstek

Örnek Başarılı Yanıt

Örnek Başarısız Yanıtlar

Örnek Başarısız Yanıtlar

Örnek Başarısız Yanıtlar