Kazpost™ Developers /
Postcode® API
Описание REST сервисов АО Казпочта
АО Казпочта, предоставляет сторонним клиентам подключатся через REST API сервис.
По всем вопросам необходимо обратиться по почтовому адресу :
postcode@kazpost.kz
На данный момент доступны следуюшие сервисы :
Description in english (Описание сервиса на английском) -
download
Сервис - SMS STATUS
REST-API по получению СМС сообщении
Метод : GET
Тестовый URL сервиса
http://pls-test.post.kz/api/smsgate/sms-status/{:partnercode}/{:barcode}
Основной URL сервиса
https://pls.post.kz/api/smsgate/sms-status/{:partnercode}/{:barcode}
Параметры :
{:partnercode} - Индивидуальный код партнера
{:barcode} - Номер почтового отпрваления
Пример Запроса:
http://pls-test.post.kz/api/smsgate/sms-status/7tech9/BK952650454KZ
{
"mail_id":"BK952650454KZ",
"info":[
{"smsDateCompleted":1558995038000,
"status":"DELIVERED",
"telegramUnread":"TELEGRAM UNREAD"},
{"smsDateCompleted":1562262126962,
"status":"DELIVERED",
"telegramUnread":"TELEGRAM UNREAD"
}
]
}
Параметры ответа:
{:mail_id} - Номер почтового отпрваления
{:smsDateCompleted} - Дата доставки смс-сообщения
{:status} - Статус смс-сообщения
{:telegramUnread} - Статус телеграмм-сообщения
Описание смс статусов :
Конечные статусы :
DELIVERED - статус успешной доставки смс абоненту сотовой связи
UNDELIVERABLE - невозможно доставить (причины: транспортные, логические). Данный статус означает "Ошибка требует дополнительного изучения" - пример, временная блокировка на предоставление сервиса на стороне оператора. Такое бывает в случаях, когда абонент превышает разрешённый лимит при постоплатной системе расчётов
EXPIRED - сот телефон клиента вне зоны доступа, либо срок жизни истек. Статус EXPIRED означает, что срок жизни сообщения истёк на SMSC оператора. В течение срока жизни сообщения был предпринят ряд попыток доставить сообщение, но все попытки были безуспешны. В этом случае система проставляет статус EXPIRED и не переотправляет сообщение повторно, так как это приведёт в дополнительным затратам
REJECTED - не существующий номер. Статус REJECTED проставляется оператором в случае, когда номер абонента не существует. В данном случае, вероятно, указан некорректный номер получателя
REJECTED - не существующий номер. Статус REJECTED проставляется оператором в случае, когда номер абонента не существует. В данном случае, вероятно, указан некорректный номер получателя
REJECTED - не существующий номер. Статус REJECTED проставляется оператором в случае, когда номер абонента не существует. В данном случае, вероятно, указан некорректный номер получателя
REJECTED - не существующий номер. Статус REJECTED проставляется оператором в случае, когда номер абонента не существует. В данном случае, вероятно, указан некорректный номер получателя
Неконечные статусы (не финальная стадия статуса) :
ENROUTE - не финальная стадия статуса, должен обновится в течении срока жизни. Он означает, что сообщение было передано в доставку в сеть оператора и ответная реакция, достаточная для проставления следующего статуса, не была получена от оператора. Так бывает с сообщениями, отправленными на абонентов находящихся в роуминге
SCHEDULED - не финальная стадия статуса. Сообщение поставлено в очередь на отправку. Доставка сообщения ещё не начата
Описание телеграмм статусов:
TELEGRAM UNREAD - Не прочитано
TELEGRAM READ - Прочитано
Примечание:
Если клиент прочитал телеграмм-сообщение , в таком случаи смс-сообщение не отправляется.
Сервис - Типы объектов
Предоставляет Список типов объектов и строений
URL сервиса
https://api.post.kz/api/types
Пример :
https://api.post.kz/api/types
{
"total" : "100"
"data" : [
{
'id':'asdf',
'nameRus':'asdf',
'nameKaz':'asdf'
},
....
{
'id':'asdf',
'nameRus':'asdf',
'nameKaz':'asdf'
}
]
Сервис - Поиск объектов
Cписок объектов по родителю
URL сервиса
https://api.post.kz/api/objects/{parent}?from={from}
Пример :
https://api.post.kz/api/objects/A1?from=0
Параметры :
{parent} - Идентификатор родителя
{from} - Начальная позиция для выдачи результатов, не более 100 результатов в ответе
Сервис - Поиск строений
Cписок строений по родителю
URL сервиса
https://api.post.kz/api/buildings/{parent}?from={from}
Пример :
https://api.post.kz/api/buildings/G195112?from=0
Параметры :
{parent} - Идентификатор родителя
{from} - Начальная позиция для выдачи результатов, не более 100 результатов в ответе
Сервис - Поиск по адресу
Cписок строений по адресу
URL сервиса
https://api.post.kz/api/byAddress/{address}?from={from}
Пример :
https://api.post.kz/api/byAddress/астана кунаева 8?from=0
Example :
https://api.post.kz/api/byAddress/astana kunaeva dom 8?from=0
Параметры :
{address} - Строка для поиска
{from} - Начальная позиция для выдачи результатов, не более 100 результатов в ответе
- Дополнительная возможность поиска на латинице
Сервис - Поиск по почтовому индексу
Cписок строений по указанному префиксу
URL сервиса
https://api.post.kz/api/byPostcode/{postcode}?from={from}
Пример :
https://api.post.kz/api/byPostcode/Z00T0B8?from=0
Параметры :
{postcode} - Почтовый индекс
{from} - Начальная позиция для выдачи результатов, не более 100 результатов в ответе
Сервис - Поиск строений по почтовому (цифровому) индексу отделения
Список строений по указанному префиксу
URL service
http://api.postcode.kz/api/byOldPostcode/{oldPostcode}?from={from}
Пример :
https://api.post.kz/api/byOldPostcode/160000?from=100
Параметры :
{oldPostcode} - Цифровой почтовый индекс
{from} - Начальная позиция для выдачи результатов, не более 100 результатов в ответе
Сервис - Поиск (выгрузка) по региону (фиксированное количество столбцов)
Список строений с указанием нового индекса строения, адреса строения (фиксированное количество столбцов) и цифрового индекса почтового отделения по указанному буквенному коду региона
URL сервиса
https://api.post.kz/api/byRegion/fixed/{region}
Пример:
https://api.post.kz/api/byRegion/fixed/Z
Параметры :
{region} - Буквенный код региона
Регионы Казахстана и соответствующие буквенные обозначения: г.Астана - Z, г.Алматы - A, Акмолинская - C, Алматинская - B, Актюбинская - D, Атырауская - E, Восточно-Казахстанская - F, Жамбылская - H, Западно-Казахстанская - L, Карагандинская - M, Кызылординская - N, Костанайская - P, Мангистауская - R, Павлодарская - S, Северо-Казахстанская - T, Туркестанская область - X, г.Шымкент - Y.
Для просмотра сгенерированных файлов рекомендуем использовать ПО - LibreOffice, либо открывать в блокноте и пересохранять файл в кодировке UTF-8. MS Excel не всегда распознает .csv с кодировкой
Инструкция для скачивания новых почтовых индексов и адресных данных с https://api.post.kz/
Для скачивания новых почтовых индексов и адресных данных городов/областей
необходимо после последнего символа «/» вместо буквенного обозначения «Z» указать
буквенное обозначение искомого города/области согласно Таблицы 1.
Таблица 1.
После скачивания, необходимо в excel формате произвести конвертацию данных.
Конвертация производится следующим образом:
- Скачивается файл, сохраняется на рабочем столе или в папке;
- Создается чистый файл excel формате, нажимаем вкладку «Данные»;
- После жмем вкладку «Из текста»
- Выбираем скаченный файл
- Выбираем с разделителями и жмем далее
- После выбираем пункт точка с запятой и жмем далее
- В самом конце жмем «Готово» и файл будет нужного формата.
Примечание* - Данный материал находится на стадии разработки. Для удобного просмотра ответа JSON, рекомендуем использовать - http://codebeautify.org/jsonviewer