Giriş
E-Mutabakat Web API bir Restful Web API'dir.
Bu API ile yapabileceğiniz işlemler aşağıda listelenmiştir.
Servis Authentication
API'mize yapılacak isteklerden önce bir token alınması gerekilmesi gerekmektedir. Bunun için /token
URL'si kullanılarak size verilen API KEY'inizi kullanabilirsiniz.
URL |
/token
|
---|---|
METHOD | POST |
URL Parametreleri | Bu serviste URL Parametresi kullanılmamaktadır. |
Request Header |
Content-Type=application/x-www-form-urlencoded Accept=application/json |
Request Body |
Zorunlu: grant_type=password username=[string] |
Response Body (Success) |
access_token=[string] token_type=[string] expires_in=[integer] |
Response Body (Error) |
error=[string] error_description=[string] |
Örnek Request (ajax) |
|
Servisler
Web API'mizin sağladığı servisler ile bir çok işlemi gerçekleştirebilirsiniz. Bunlardan bazıları; Aktarım gerçekleştirme, Dışarıya veri alma, Veri doğrulama gibi.
Aktarım Servisleri
API'mizin sunduğu aktarım servisleri ile e-mutabakat portalına veri aktarımları sağlayabilirsiniz.
Aktarım İsteği Sorgulama
Size verilen API KEY ile yapacağınız bu sorgulama ile e-mutabakat portal üzerinden bir "Servis Aktarımı" isteği yapılıp yapılmadığını -yani portal kullanıcısının aktarım emri verip vermediğini- sorgulayabilirsiniz.
URL |
/aktarim/sorgulama
|
---|---|
METHOD | GET |
URL Parametreleri |
Zorunlu: api_key=[string] |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body | Bu serviste request body alanında herhangi bir veri gönderilmez. |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
Aktarım İsteği Oluşturma
Bu servis ile e-mutabakat portal kullanıcısının herhangi bir aktarım isteğini oluşturmasını beklemeksizin manuel olarak bir aktarım isteği oluşturulabilir. Ancak bu işlemden önce aktarım ID oluşturma servisi kullanılarak bir aktarım ID alınmalıdır.
URL |
/aktarim/istek-olusturma
|
---|---|
METHOD | POST |
URL Parametreleri | Bu serviste URL alanında herhangi bir veri gönderilmez. |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: api_key=[string] aktarilacak_tur=[string] yil=[string] ay=[string] kosul=[string] kosul_borc_tutar=[string] kosul_alacak_tutar=[string] aktarim_id=[string] |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
Aktarım Durumu Güncelleme
Gerçekleştirilen bir aktarımın durumu bu servis ile değiştirilebilir.
URL |
/aktarim/durum-guncelleme
|
---|---|
METHOD | PUT |
URL Parametreleri | Bu serviste URL alanında herhangi bir veri gönderilmez. |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: api_key=[string] aktarim_id=[string] aktarim_durum=[string] |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
Aktarım ID Oluşturma
Bu servis manuel bir aktarım gerçekleştirmek için sistem üzerinden yeni bir aktarım ID almak için kullanılır.
URL |
/aktarim/id-olusturma
|
---|---|
METHOD | POST |
URL Parametreleri | Bu serviste URL alanında herhangi bir veri gönderilmez. |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: api_key=[string] aktarilacak_tur=[string] yil=[string] ay=[string] kosul=[string] kosul_borc_tutar=[string] kosul_alacak_tutar=[string] aktarim_id=[string] aktarim_durum=[string] |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
Cari Kart Aktarımı
Bu servis ile e-mutabakat sistemine cari kartların aktarımı sağlanır.
URL |
/aktarim/carikart-aktarimi
|
---|---|
METHOD | POST |
URL Parametreleri |
Zorunlu: api_key=[string] aktarim_id=[string] |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: aktarim_id=[string] api_key=[string] cari_grup=[string] unvan=[string] mersis_no=[string] vergi_no=[string] vergi_dairesi=[string] telefon=[string] telefon_alternatif=[string] faks=[string] ulke=[string] ulke_kod=[string] adres=[string] musteri_kod=[string] muhasebe_kod=[string] sube=[string] aciklama=[string] para_birim=[string] email=[string] form_ba_email=[string] form_bs_email=[string] cari_hesap_email=[string] ozel_mutabakat_email=[string] kep_mail=[string] bakiye_gonderim_tur=[string] (bakiye_gonderim_tur parametresi 0 gönderilirse: Müşteri Kodu Bazında Gönderim (Her bir müşteri kodu ayrı ayrı gider.)) (bakiye_gonderim_tur parametresi 1 gönderilirse: Cari Kart Toplam Bakiye Gönderimi (Tüm müşteri kodları tek bir mailde gider.)) (bakiye_gonderim_tur parametresi 2 gönderilirse: Cari Grup Bazında Gönderim (Her bir grup topluca gider.)) |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
Form BA/BS Aktarımı
Bu servis ile e-mutabakat sistemine Form BA/BS aktarımı sağlanır.
URL |
/aktarim/formbabs-aktarimi
|
---|---|
METHOD | POST |
URL Parametreleri |
Zorunlu: api_key=[string] aktarim_id=[string] |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: aktarim_id=[string] api_key=[string] cari_grup=[string] yil=[string] ay=[string] vergi_no=[string] unvan=[string] musteri_kod=[string] babs=[string] belge_adet=[string] belge_tutar=[string] |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
Cari Hesap Aktarımı
Bu servis ile e-mutabakat sistemine Cari Hesap aktarımı sağlanır.
URL |
/aktarim/carihesap-aktarimi
|
---|---|
METHOD | POST |
URL Parametreleri |
Zorunlu: api_key=[string] aktarim_id=[string] |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: aktarim_id=[string] api_key=[string] cari_grup=[string] yil=[string] ay=[string] vergi_no=[string] unvan=[string] musteri_kod=[string] bakiye=[string] para_birim=[string] hareket_kod=[string] İsteğe Bağlı: ozel_1=[string] ozel_2=[string] ozel_3=[string] |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|
E-Tahsilat Aktarımı
Bu servis ile e-mutabakat sistemine E-Tahsilat bilgi aktarımı sağlanır.
URL |
/aktarim/etahsilat-aktarimi
|
---|---|
METHOD | POST |
URL Parametreleri |
Zorunlu: api_key=[string] aktarim_id=[string] |
Request Header |
Content-Type=application/json Accept=application/json |
Request Body |
Zorunlu: aktarim_id=[string] api_key=[string] vergi_no=[string] musteri_kod=[string] bakiye=[string] para_birim=[string] kur=[string] tahsilat_para_birim=[string] İsteğe Bağlı: ozel_1=[string] ozel_2=[string] ozel_3=[string] |
Response Body (Success) |
Response Parametre Açıklamaları: |
Response Body (Error) |
|
Örnek Request (ajax) |
|