İstek Yapısı

POST/GET HOST

API HOST: https://organikapi.com/

POST/GET URL

/vapi_version/api_key/request_name/request_response_type/response_type/

Örnek POST/GET URL'si

https://organikapi.com/v2/ce136df4c9c92d1428e828aba07d3b05/balance/

https://organikapi.com/v2/ce136df4c9c92d1428e828aba07d3b05/sendsms/json/xml/

API'ye gönderdiğiniz istek yapısı yukarıdaki gibi olmalıdır. İstek yolundaki değişkenlerin değerleri aşağıdaki tabloda verilmiştir.

Değişken	Gereklilik	Varsayılan Değer	Açıklama
`api_version`	`Zorunlu`	N/A	Kullandığınız API'nin versiyonunu belirtir. Bu dokümantasyonun hazırlandığı son sürüm v2.0'dır. Bu yüzden bu değer 2 olmalıdır.
`api_key`	`Zorunlu`	N/A	API'nin size yanıt verebilmesi için gerekli API anahtarı değeridir. "API Anahtarı Oluşturma" başlığında nasıl belirleneceği anlatılmıştır.
`request_name`	`Zorunlu`	N/A	API'ye hangi görevi yapmasını istediğiniz belirttiğiniz değişkendir. Bu değişkenin değerine göre API farklı görevleri yapar ve yanıt verir. API'nin görevleri bu değişkenin alabileceği değerler bir sonraki tabloda anlatılmıştır.
`request_response_type`	`Opsiyonel`	JSON	API'ye POST ettiğiniz istek gövdesinin formatını belirttiğiniz değişkendir. POST ettiğiniz verinin formatına göre değer almalıdır. Gönderdiğiniz istek gövdesi XML ise, `XML`, JSON ise, `JSON` olmalıdır. Bu değişken opsiyonel olup, hiçbir şey yazılmaması durumunda varsayılan olarak JSON formatında veri bekler. Bu değişkenin çalışma prensibi ve koşulları aşağıda anlatılmıştır.
`response_type`	`Opsiyonel`	request_response_type	Organik API farklı format tipleriyle istek alıp yanıt verebilir. API'nin döndürdüğü yanıtın hangi formatta olmasını istediğinizi bu değişkenle belirtirsiniz. Yanıtı XML olarak almak istiyorsanız, bu değişkene `XML` değeri vermelisiniz. Eğer bu değişkeni kullanmazsanız hem beklenen istek tipi hem de verilecek tipi request_response_type değerine verdiğiniz formatta olur.

POST/GET Alabileceği Yanıt, İstek ve Fonskiyon Değerleri

Bu bölümde URL'de yer alan request_name, request_response_type ve response_type değişkenlerinin alabileceği değerler ve anlamları anlatılmıştır. API fonksiyonlarının detaylı anlatımları, ilgili başlıklar altında verilmiştir.

`request_name`
Metod	Alabileceği Değer	Açıklama
GET	`balance`	Kredi sorgulama metodudur. API'ye bu değer gönderildiğinde size sonuç olarak hesabınızdaki TL ve SMS kredi bakiyenizi döndürür.
GET	`headers`	Kayıtlı gönderen kimliklerinizi (başlıklarınızı) sorgulama metodudur. Yanıt olarak başlık ID ve başlık isimlerini döndürür.
GET	`smsviaget`	GET ile tekli SMS gönderme metodudur. Detaylı anlatımı SMS Gönderme başlığında verilmiştir.
POST	`sendsms`	Toplu ve hitaplı SMS gönderme metodudur. Detaylı anlatımı SMS Gönderme başlığında verilmiştir.
POST	`detailedreport`	Detaylı rapor alma metodudur. Detaylı anlatımı Detaylı Rapor Alma başlığında verilmiştir.
POST	`basicreport`	Basit rapor alma metodudur. Detaylı anlatımı Basit Rapor Alma başlığında verilmiştir.
GET	`groups`	Kayıtlı grupları sorgulama metodudur. Grup ID'leri, isimleri ve gruplardaki kayıtlı kişi sayılarını döndürür.
POST	`groupcontent`	Belirli grup veya grupların kişi bilgilerini sorgulama metodudur. Kişilerin ID, ad, soyad, doğum tarihi gibi bilgilerini döndürür.
POST	`cancelscheduledtasks`	İleri tarihli gönderimleri iptal etme metodudur.
GET	`blacklist`	Kara listenizdeki numaraları listeleme metodudur. GSM numaralarını ve kara listeye eklenme tarihlerini döndürür.
POST	`blacklistadd`	Kara listeye numara ekleme metodudur.
POST	`blacklistremove`	Kara listeden numara çıkarma metodudur.

`request_response_type`
request_response_type parametresi ile API'ye gönderdiğiniz bilgilerin ve almak istediğiniz yanıtın hangi formatta olacağını belirtirsiniz. Örneğin sadece request_response_type değerine XML atandığı durumlarda API hem yanıt hem de istek gövdelerini XML formatında bekler ve döndürür. Kullanılması zorunlu değildir. Varsayılan değeri JSON'dır.
Tip	Alabileceği Değer	Açıklama
String	JSON	POST ettiğiniz istek gövdesi tipinin JSON olması durumunda bu değer verilmelidir. request_response_type değeri URL'de belirtilmezse varsayılan olarak bu değer atanır ve POST edilen istek gövdesi JSON gibi işlenir.
String	XML	POST ettiğiniz istek gövdesi tipinin XML olması durumunda bu değer verilmelidir.

`response_type`
response_type almak istediğiniz yanıtın hangi formatta olacağını belirler. Kullanılması zorunlu değildir. Gönderilmediği taktirde değerini request_response_type parametresinden alır. request_response_type parametresi ile aynı değeri almak zorunda değildir, ayrı çalışır.
Tip	Alabileceği Değer	Açıklama
String	JSON	Almak istediğiniz yanıt JSON formatında ise bu değer verilmelidir.
String	XML	Almak istediğiniz yanıt XML formatında ise bu değer verilmelidir.

Organik API'yi kullanarak SMS gönderimi yapabilmeniz için aboneliğinizin olması gerekmektedir. Eğer aboneliğiniz yoksa buraya tıklayarak ücretsiz aboneliğinizi hızlı bir şekilde başlatabilirsiniz.