Вы продаете товары через интернет? У Вас интернет-магазин и вы реализуете товары с доставкой?Покупатель не забрал посылку из почтового отделения или после заказа перестал отвечать на звонки? Курьер привез заказ, но покупатель не открыл ему дверь и не принял заказ? При этом Вы, как продавец, несете материальные затраты, которые покупатель отказывается компенсировать? Внесите данные неблагонадежного покупателя в Black List и обезопасьте себя и других продавцов от ненадежных клиентов в будущем!
API взаимодействиеДля интернет-магазинов построенных на CMS OpenCart версии 1.5 и 2.0 мы разработали готовые модули для прямой интеграции.
Ссылки для скачивания доступны всем зарегистрированным пользователям.
Проверка внесен ли клиент в Black List осуществляется json запросом на адрес https://blacks.by/api.php
Запрос должен содержать следующие данные:
- getphone=
- id=
- api_key=
ГДЕ:
getphone - указывает на проверяемый номер телефона
id - это ваш уникальный id который можно найти в личном кабинете
api_key - это ваш уникальный ключ который можно найти в личном кабинете
Пример запроса:
https://blacks.by/api.php?getphone=80291234567&id=34&api_key=149e91af54fb5dd
Где проверяемый номер телефона 80291234567, id 34 и api_key соответственно 1149e91af54fb5dd
В ответ на данный запрос сервер формирует json ответ:
status
response
error
status - возвращает "OK" если запрос верный. Возвращает "ERROR" если запрос неверный.
response - возвращает "TRUE" если запрос верный и контакт внесен в Black List. Возвращает "FALSE" если запрос верный и контакт не внесен в Black List. Возвращает "NULL" если запрос неверный.
error - возвращает код ошибки. Если в ответе status = "OK", то error = "0". Если в ответе status = "ERROR", то error = "номер ошибки".
Пример ответа сервера на запрос с ошибкой:
{"status":"ERROR","response":null,"error":3}
Пример ответа сервера на верно сформированный запрос и запрашиваемый номер НЕ внесен в Black List:
{"status":"OK","response":false,"error":0}
Пример ответа сервера на верно сформированный запрос и запрашиваемый номер внесен в Black List:
{"status":"OK","response":true,"error":0}
Пример скрипта для проверки номера телефона:
<?php $phone = '+375296112233'; $id = '1'; $api_key = '098f6bcd4621d373cad832627b4f6'; $resp = file_get_contents('https://blacks.by/api.php?getphone='.$phone.'&id='.$id.'&api_key='.$api_key); $data = json_decode($resp, true); if($data['status']=='OK'){ if($data['response']){ echo 'Внимание! Неблагонадежный клиент'; }else{ echo 'Клиент не внесен в Black List'; } }else{ echo 'Код ошибки: '.$data['error']; } ?>
Внесение клиента в Black List осуществляется json запросом на адрес https://blacks.by/api.php
Запрос должен содержать следующие данные:
- postphone=
- id=
- api_key=
ГДЕ:
postphone - указывает на вносимый номер телефона
id - это ваш уникальный id который можно найти в личном кабинете
api_key - это ваш уникальный ключ который можно найти в личном кабинете
Пример запроса:
https://blacks.by/api.php?postphone=80291234567&id=34&api_key=149e91af54fb5dd
Где вносимый номер телефона 80291234567, id 34 и api_key соответственно 149e91af54fb5dd
В ответ на данный запрос сервер формирует json ответ:
status
response
error
status - возвращает "OK" если запрос верный. Возвращает "ERROR" если запрос неверный.
response - возвращает "TRUE" если запрос верный и контакт успешно внесен в Black List. Возвращает "FALSE" если запрос верный и контакт ранее внесен в Black List. Возвращает "NULL" если запрос неверный.
error - возвращает код ошибки. Если в ответе status = "OK", то error = "0". Если в ответе status = "ERROR", то error = "номер ошибки".
Пример ответа сервера на запрос с ошибкой:
{"status":"ERROR","response":null,"error":3}
Пример ответа сервера на верно сформированный запрос и вносимый номер ранее внесен в Black List:
{"status":"OK","response":false,"error":0}
Пример ответа сервера на верно сформированный запрос и вносимый номер успешно внесен в Black List:
{"status":"OK","response":true,"error":0}
Пример скрипта для внесения номера телефона:
<?php $phone = '+375296112233'; $id = '1'; $api_key = '098f6bcd4621d373cade832627b4f6'; $resp = file_get_contents('https://blacks.by/api.php?postphone='.$phone.'&id='.$id.'&api_key='.$api_key); $data = json_decode($resp, true); if($data['status']=='OK'){ if($data['response']){ echo 'Клиент успешно внесен в Black List'; }else{ echo 'Клиент ранее внесен в Black List'; } }else{ echo 'Код ошибки: '.$data['error']; } ?>
| Код ошибки | Расшифровка ошибки |
|---|---|
| 1 | В запросе не был передан хотя бы один из параметров |
| 2 | В запросе некорректный номер телефона |
| 3 | В запросе передан неверный API_KEY или ID |