Introduction

The Sipariş Dijital CRM API follows RESTful architecture standards, offering clear and consistent resource-based endpoints. All requests and responses are transmitted in JSON format, leveraging standard HTTP verbs, status codes, and authentication protocols to enable secure, efficient, and scalable integrations.

API Base URL

Please note that Sipariş Dijital CRM does not provide a sandbox or test environment. All API requests are processed in the live environment, so ensure that all request data and parameters are accurate before making any calls.

https://siparisdijital.com.tr/external-api

Authentication

All requests to the Sipariş Dijital CRM API require authentication. Each API request must include a valid client-id and client-secret to the request header, which can be obtained from your Sipariş Dijital CRM Dashboard under Developer Tools.

In addition to credentials, Sipariş Dijital CRM enforces IP-based security. You must register and enable your server’s public IP address in the IP Whitelist section of the dashboard. Requests originating from non-whitelisted IP addresses will be automatically rejected.

Both valid API credentials and an approved IP address are mandatory. Without completing these two steps, authentication will fail and API access will not be granted.

Response Format

All responses from the Sipariş Dijital CRM API are returned in JSON format. Each response follows a consistent structure and includes a status indicator, message, and relevant data payload when applicable. Standard HTTP status codes are used to represent the outcome of each request.

Örnek Başarı Yanıtı

{
"status": "success",
"remark": "contact_list",
"message":[
    "Contact list fetched successfully"
],
"data": {
   ...you get all data here
    }
}

Hata Örneği Yanıtı

{
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "The client secret is required"
    ]
}

 {
    "remark": "Unauthorized",
    "status": "error",
    "message": [
        "Access to this API endpoint is restricted to IP addresses that have been explicitly whitelisted.",
        "In order to access this API endpoint, please add your IP address (::1) to the white list from the user dashboard."
    ]
}


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/contact/list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Get Contact List

This endpoint allows you to retrieve a complete list of contacts associated with your Sipariş Dijital CRM account.

GET

contact/list

Sorgu Parametreleri

API yanıtını özelleştirmenize olanak tanıyan sorgu parametreleri.

İsim	Tanım	Gerekli	Varsayılan
`Sayfa`	Alınacak sayfa numarasını belirtir.	Hayır	1
`Sayfalama`	Sayfa başına döndürülecek öğe sayısını tanımlar.	Hayır	20
`Arama`	Kişileri ad, soyad veya cep telefonu numarasına göre arar.	Hayır	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/contact/store',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Yeni Kişi Oluştur

This endpoint allows you to add a new contact to your Sipariş Dijital CRM account. Provide the necessary contact details, and upon successful request, the API returns the created contact’s information in JSON format for easy integration.

POST

/contact/store

Zorunlu Alanlar

Sisteme yeni bir kişi eklemek için aşağıdaki alanların doldurulması zorunludur.

İsim	Gerekli	Varsayılan
`İsim`	Evet	-
`Soyisim`	Evet	-
`mobil_kod`	Evet	-
`Mobil`	Evet	-
`İl`	Hayır	-
`İlçe`	Hayır	-
`post_code`	Hayır	-
`Adres`	Hayır	-
`profile_image`	Hayır	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/contact/update/{contactId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Kişiyi Güncelle

Bu uç nokta, mevcut bir kişiyi güncellemenizi sağlar. Sadece değiştirmek istediğiniz alanları göndermeniz yeterlidir. İsteğe dahil edilmeyen alanlar değişmeden kalacaktır.

POST

/contact/update/{id}

Zorunlu Alanlar

Sisteme yeni bir kişi eklemek için aşağıdaki alanların doldurulması zorunludur.

İsim	Gerekli	Varsayılan
`İsim`	Evet	-
`Soyisim`	Evet	-
`mobil_kod`	Evet	-
`Mobil`	Evet	-
`İl`	Hayır	-
`İlçe`	Hayır	-
`post_code`	Hayır	-
`Adres`	Hayır	-
`profile_image`	Hayır	-


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/contact/delete/{contactId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'DELETE',
  CURLOPT_POSTFIELDS => array('firstname' => 'John','lastname' => 'Doe','mobile_code' => '880','mobile' => '01988'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Kişiyi Sil

Bu uç nokta, bir kişiyi benzersiz kimliğiyle silmenizi sağlar. Kişinin ilişkili mesajları varsa veya engellenmişse silme işlemi kısıtlanabilir.

DELETE

/contact/delete/{id}


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/inbox/conversation-list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Konuşma Listesi

Kimliği doğrulanmış kullanıcıya ait, iletişim bilgileri ve konuşma durumu da dahil olmak üzere, sayfalandırılmış bir konuşma listesini alın.

GET

/inbox/conversation-list

Sorgu Parametreleri

İsim	Tanım	Varsayılan
`status`	Konuşmaları duruma göre filtreleyin. Konuşmaları duruma göre filtrelemek için aşağıdaki değeri kullanın. Done = 1; Pending = 2; Important = 3; Unread = 4;	Tüm
`Sayfa`	Alınacak sayfa numarasını belirtir.	1
`Sayfalama`	Sayfa başına döndürülecek öğe sayısını tanımlar.	20


$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/inbox/change-conversation-status/2',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('status' => '1'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Konuşma Durumunu Değiştir

Bir konuşmanın durumunu beklemede, tamamlandı veya önemli gibi şekilde güncelleyin. Burada Tamamlandı = 1, Beklemede = 2, Önemli = 3, Okunmadı = 4'tür.

POST

/inbox/change-conversation-status/{conversation_id}

URL Parametreleri

Parametre	Tip	Tanım
`conversation_id`	integer	Konuşmanın benzersiz kimliği

Talep Gövdesi

Alan	Tip	Gerekli
`status`	integer	YEs


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/inbox/conversation-details/2',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_POSTFIELDS => array('status' => '1'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Konuşma Detayları

İletişim bilgileri, notlar, etiketler ve liste ilişkileri de dahil olmak üzere bir konuşmanın tüm ayrıntılarını alın.

GET

/inbox/conversation-details/{conversation_id}

URL Parametreleri

Parametre	Tip	Tanım
`conversation_id`	integer	Konuşmanın benzersiz kimliği


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/inbox/send-message',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('mobile_code' => '880','mobile' => xxxxxxxxx','message' => 'Hello world'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;

Mesaj Gönder

Bir cep telefonu numarasına WhatsApp mesajı gönderin. Bu uç nokta metin, medya, konum, etkileşimli listeler, harekete geçirici mesaj URL'leri ve e-ticaret mesajlarını destekler. Verilen telefon numarası için mevcut bir kişi veya görüşme bulunamazsa, otomatik olarak yeni bir kişi ve görüşme oluşturulacaktır.

POST

/inbox/send-message

Talep Gövdesi

Alan	Tip	Gerekli	Tanım
`mobile_code`	string	yes	Mobil ülke kodu. Artı (+) işareti içermeyen geçerli bir sayısal ülke kodu olmalıdır.
`mobile`	string	yes	Verilen ülke koduyla ilişkilendirilmiş geçerli bir cep telefonu numarası.
`from_number`	string	conditional	Hesabınızda ve Meta kontrol panelinde kayıtlı geçerli bir WhatsApp Business telefon numarası gereklidir. Kimlik bilgisi sağlanmazsa, mesaj varsayılan kayıtlı WhatsApp hesabınız kullanılarak gönderilecektir.
`message`	string	Conditional	Metin mesajı içeriği. Medya, konum veya etkileşimli veri sağlanmadığı durumlarda gereklidir.
`image`	file	No	Resim dosyası (jpg, jpeg, png – maksimum 5 MB)
`document`	file	No	Belge dosyası (pdf, doc, docx – maksimum 100 MB)
`video`	file	No	Video dosyası (mp4 – maksimum 16 MB)
`audio`	file	No	Ses dosyası – maksimum 16 MB
`latitude`	decimal	Conditional	Konum mesajı için enlem
`longitude`	decimal	Conditional	Konum mesajı için boylam
`cta_url_id`	integer	No	Etkileşimli düğme mesajları için CTA URL kimliği
`interactive_list_id`	integer	No	Etkileşimli liste kimliği

Notlar

En az bir mesaj türü belirtilmelidir.

Etkileşimli mesajlar aktif bir planlama gerektirir.

Engellenen kişiler mesaj gönderemez veya alamaz.


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/inbox/send-template-message',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('mobile_code' => '880','mobile' => 'xxxxxx','testmplate_id' => 'your template id'),
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Şablon Mesajı Gönder

Onaylanmış bir WhatsApp şablon mesajını mevcut bir konuşmaya gönderin. Şablon mesajlar genellikle bildirimler, uyarılar ve iş amaçlı iletişim için kullanılır.

POST

/external-api/inbox/send-template-message

Talep Gövdesi

Alan	Tip	Gerekli	Tanım
`mobile_code`	string	yes	Mobil ülke kodu. Artı (+) işareti içermeyen geçerli bir sayısal ülke kodu olmalıdır.
`mobile`	string	yes	Verilen ülke koduyla ilişkilendirilmiş geçerli bir cep telefonu numarası.
`from_number`	string	conditional	Hesabınızda ve Meta kontrol panelinde kayıtlı geçerli bir WhatsApp Business telefon numarası gereklidir. Kimlik bilgisi sağlanmazsa, mesaj varsayılan kayıtlı WhatsApp hesabınız kullanılarak gönderilecektir.
`template_id`	integer	Yes	Onaylanmış WhatsApp şablon kimliği

Notlar

Yalnızca onaylanmış WhatsApp şablonları gönderilebilir.

Şablon mesajlar genellikle işletme tarafından başlatılan görüşmelerde kullanılır.

Engellenen kişiler şablon mesajları alamaz.

Mesaj göndermeden önce WhatsApp hesabınızın bağlı olması gerekir.


$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://siparisdijital.com.tr/extern-api/inbox/template-list',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'client-id: YOUR-CLIENT-ID',
    'client-secret: YOUR-CLIENT-SECRET',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Şablon Listesini Al

Bu uç nokta, hesabınızla ilişkili tüm WhatsApp şablonlarını almanıza olanak tanır.

POST

/inbox/template-list