API сайта разработчикам и интернет магазинам
Для разработчиков доступно API нашего сайта. С помощью API можно получить:
- отслеживание почтовых отправлений (API Почты России)
- расчет сроков доставки и стоимости доставки (Почта России)
- адреса и телефоны почтовых отделений
- печать бланков Почты России из со своего приложения
- адресная информация (ФИАС API)
1. Описание API для отслеживания почтовых отправлений
Параметры запроса
Тип запроса - POSTАдрес - http://digi-post.ru/tracking/trackit/api
Параметр | Тип | Описание |
---|---|---|
key | varchar | Ваш api ключ |
method | varchar | Метод запроса (get, post, get_arrived) |
type | varchar | Тип ответа: JSON или XML |
track_id | varchar | Трекинг код |
order_id | varchar | Номер заказа в вашем магазине |
client_phone | varchar | телефон клиента для уведомлений, формат 79110000000 |
client_email | varchar | email клиента для уведомлений |
client_name | varchar | Имя клиента для уведомлений |
client_surname | varchar | Фамилия клиента для уведомлений |
Описание методов
Тип | Описание |
---|---|
get | Запрос на отлеживание определенного трекинг кода (полное отслеживание) |
post | Добавление трекинг кода на отслеживание в Личный Кабинет на нашем сайте. (Дает возможность получать email или sms о передвижении) |
get_arrived | Выдать список треккодов, которые прибыли в место вручения, но еще не были вручены. Возвращает треккод и описание. |
Параметры ответа
Ответ в виде массива значений выбранного типа (JSON или XML)
Ключ | Тип | Описание |
---|---|---|
type | varchar | Тип операции |
attribute | varchar | Аттрибут операции |
placePostCode | varchar | Почтовый код места операции |
placeName | varchar | Место операции |
date | varchar | Дата операции |
weight | varchar | Вес отправления |
declaredValue | varchar | Оценочная стоимость |
onDeliveryPrice | varchar | Сумма наложенного платежа, которую необходимо оплачить получателю |
dstPostCode | varchar | Почтовый код отделения, куда направляется посылка |
dstAddress | varchar | Адрес, куда направляется посылка |
Примеры запросов
1. узнать полную информацию о движении трека 10100062815028 (в xml), метод get:
http://digi-post.ru/tracking/trackit/api?key=ВАШ_API_КЛЮЧ&method=get&type=xml&track_id=10100062815028
2. закинуть в Личный кабинет трек 10100062815028, метод post:
http://digi-post.ru/tracking/trackit/api?key=ВАШ_API_КЛЮЧ&method=post&type=xml&track_id=10100062815028&client_phone=79110000000&client_email=client@email.com&order_id=23545
3. узнать, какие посылки прибыли в место вручения, но не были вручены (в xml), метод get_arrived:
http://digi-post.ru/tracking/trackit/api?key=ВАШ_API_КЛЮЧ&method=get_arrived&type=xml
2. Описание API для расчета стоимости доставки
Тип запроса - GET
Адрес - http://digi-post.ru/api/calc
Авторизация HTTP Basic, где Username - логин при регистрации, Password - api ключ.
Параметры для запроса
Параметр | Варианты | Тип | Описание |
---|---|---|---|
to | varchar | Индекс/город/регион отправителя. Рекомендуем рассчитывать доставку по индексу. | |
from | varchar | Индекс/город/регион получателя. Рекомендуем рассчитывать доставку по индексу. | |
weight | float | Вес отправления. | |
value | float | Оценочная стоимость отправления. | |
ems | 1/0 | int | Включить в выдачу расчет доставки EMS. Если включить, выдача работает медленнее! Использовать осмотрительно. |
caution | 1/0 | int | Отметка "Осторожно". |
not_standart | 1/0 | int | Нестандартная посылка. |
Ответ на запрос
Тип доставки | Параметры в ответе |
---|---|
parcel | cost - стоимость отправки max_weight - предельный вес отправления eta - ожидаемое время прибытия description - описание |
bookpost_1class | cost_nds - стоимость отправки с НДС cost_no_nds - стоимость отправки без НДС max_weight - предельный вес отправления eta - ожидаемое время прибытия description - описание |
valued_bookpost | cost_nds - стоимость отправки с НДС cost_no_nds - стоимость отправки без НДС max_weight - предельный вес отправления eta - ожидаемое время прибытия description - описание |
bookpost | cost_simple_bookpost_cost_nds - стоимость отправки простой бандероли с НДС cost_simple_bookpost_no_nds - стоимость отправки простой бандероли БЕЗ НДС cost_reg_bookpost_cost_nds - стоимость отправки заказной бандероли с НДС cost_reg_bookpost_cost_nds - стоимость отправки заказной бандероли БЕЗ НДС max_weight - предельный вес отправления eta - ожидаемое время прибытия description - описание |
notice_of_delivery_1class | cost_no_nds - стоимость отправки БЕЗ НДС cost_nds - стоимость отправки с НДС cost_registered_no_nds - стоимость отправки БЕЗ НДС cost_registered_nds - стоимость отправки с НДС description - описание |
ems | max_weight - предельный вес отправления cost - стоимость отправки eta_min - минимальный срок доставки eta_max - максимальный срок доставки description - описание |
info | to_ops_address - адрес почтового отделения места прибытия to_ops_name - наименование почтового отделения cod - плата при получении наложки route - маршрут отправления |
3. Описание API: печать почтовых бланков
Параметры запроса
Тип запроса - POSTАдрес - http://digi-post.ru/blanks/russianpost/api
Обязательные параметры:
Параметр | Тип | Описание |
---|---|---|
key | varchar | Ваш api ключ |
blank_type | varchar | Тип бланка. Может быть только этих типов: F116, F113, F7 |
blank_type_id | varchar | Разновидность бланка Ф.7 (1 - отправление первого класса, 2 - посылка, 3 - бандероль) |
Текст для печати на бланках (по необходимости)
Адрес получателя (для бланков Ф.116, Ф.113, Ф.7)Параметр | Тип | Описание |
---|---|---|
to_name | varchar | ФИО получателя |
to_address_1 | varchar | Адрес получателя, строка 1 |
to_address_2 | varchar | Адрес получателя, строка 2 |
to_zip | varchar | Индекс получателя |
Параметр | Тип | Описание |
---|---|---|
from_name | varchar | ФИО отправителя |
from_address_1 | varchar | Адрес отправителя, строка 1 |
from_address_2 | varchar | Адрес отправителя, строка 2 |
from_zip | varchar | Индекс отправителя |
Параметр | Тип | Описание |
---|---|---|
order_price | decimal | Сумма наложенного платежа |
order_amount | decimal | Сумма оценки |
Параметр | Тип | Описание |
---|---|---|
doc_type | varchar | Тип документа (напрм., паспорт) |
doc_serial | varchar | Серия документа |
doc_num | varchar | Номер документа |
doc_date | varchar | Дата документы |
doc_received_by | varchar | Кем выдан документ |
Параметр | Тип | Описание |
---|---|---|
inn | varchar | ИНН |
correspondent_account | varchar | Корреспондентский счет |
current_account | varchar | Расчетный счет |
bank_name | varchar | Наименование банка |
bik | varchar | БИК банка |
Параметр | Тип | Описание |
---|---|---|
only_first | int | Печатать только лицевую часть бланка (Ф.113) 0-нет 1-да |