Перечень методов API

• calc - расчет стоимости доставки и контрольного срока прохождения посылок (бандеролей), отправленных Почтой России (1 класс в том числе). Подробнее
• print_f7p - печать бланка адресного ярлыка (на конверт, пластиковый пакет, коробку) по форме 7-п, 7-а, 7-б. Подробнее
• print_f116 - печать сопроводительного бланка по форме 116. Подробнее
• print_f112 - печать бланка почтового перевода по форме 112эф. Подробнее
• print_f113 - печать бланка наложенного платежа по форме 113эн. Подробнее
• print_f103 - список для отправки партионных почтовых отправлений по форме 103. Подробнее
• parcel - отслеживание посылок по РПО (почтовому идентификатору). Подробнее

В нашем API реализованы методы, которые требуют 2 разных метода аутентификации. 1 метод аутентификации - по API ключу и API паролю. 2 метод аутентификации - по API ключу и IP адресу сервера

Как работает API

Вызов методов осуществляется посредством GET или POST HTTP - запросов (на Ваш выбор) к API URL. Для запроса используйте кодировку UTF-8. В GET или POST запросах передаются аргументы с именами:

• API URL - Адрес сервера.
• API Ключ - уникальный ключ Вашего аккаунта, обязательный параметр для API запросов.
• API пароль - требуется для проверки подписи.
• IP - адрес Вашего сайта.

Основные аргументы API запроса

[in]	apikey	API ключ Вашего аккаунта. Обязательный аргумент.
[in]	method	вызываемый метод. Обязательный аргумент.
[in]	...	набор переменных, зависящих от конкретного метода.
[in]	hash	обязательный параметр если метод требует аутентификацию по API паролю.

Основные аргументы ответа

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	...	набор переменных, зависящих от конкретного метода.

---

API. Метод calc. Расчет стоимости отправки Почтового отправления

Доступ с аутентификацией по API ключу + API паролю или доступ по API ключу + IP сервера с которого будет выполнен запрос. Все аргументы запроса обязательны.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	calc
[in]	from_index	Почтовый индекс отправителя
[in]	to_index	Почтовый индекс получателя
[in]	weight	Вес, в кг. Например, 1.34
[in]	ob_cennost_rub	Объявленная ценность отправления, руб
[in]	hash	Обязательный аргумент, если аутентификация по методу API ключ + API пароль

Аргументы ответа

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	calc	Массив. Ключи каждого элемента массива: 'type' - тип отправления (rp_1class - Почта России 1 Класс, rp_main - Ценная Посылка, обычное отправление Почтой России). 'cost' - сумма доставки в рублях. 'days' - контрольный (максимальный) срок доставки.
[out]	info	Сообщение о выполнении действия в виде массива с ключами. 'from_index' - индекс отправителя. 'from_city' - город отправителя. 'from_state' - область, регион отправителя. 'to_index' - индекс получателя. 'to_city' - город получателя. 'to_state' - область, регион получателя. 'weight' - вес отправления. 'ob_cennost_rub' - объявленная ценность отправления.

PHP скрипт - пример, вызова метода calc

Будет доступен после регистрации.

---

API. Метод print_f7p. Печать бланка адресного ярлыка

Доступ с аутентификацией по API ключу + API паролю. Все аргументы запроса обязательны.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	print_f7p
[in]	print0	Значение 1 или 0. Если 1, то нулевая объявленная ценность и наложенный платеж печатается как 0 руб., иначе остается пустое место
[in]	printnalogkareq	Значение 1 или 0. Если 1, то печатаются реквизиты для наложенного платежа (также требуется значение nalogka_ur_lico_cb=1 в конкретном отправлении), иначе не печатаются
[in]	list	Массив данных о почтовых отправлениях закодированный JSON. Данные параметры печатаются без проверки. Что введено, то будет напечатано. Указывайте телефонный номер для отправления уведомлений по СМС, по факту прихода отправления в почтовое отделение (в разработке) 'parcel_type' - тип отправления. Значения: 'rp' - посылка, 'rp_1class' - отправление 1 класса, 'banderol' - бандероль. 'from_country' - страна места отправления 'from_index' - почтовый индекс места отправления 'from_state' - область/регион 'from_city' - город/населенный пункт 'from_addr' - обратный адрес отправителя (улица, дом, квартира/офис) 'from_fio' - ФИО или наименование организации отправителя 'to_country' - страна места получения 'to_index' - почтовый индекс получателя 'to_state' - область/регион 'to_city' - город/населенный пункт 'to_addr' - адрес получателя (улица, дом, квартира/офис) 'to_fio' - ФИО или наименование организации получателя 'nalogka_ur_lico_cb' - значение '1' - печатать реквизиты наложенного платежа на бланке. Значение '0' - нет 'from_inn' - ИНН получателя (ООО или ИП) 'from_bik' - БИК Банка, в котором открыт счет 'from_bank' - наименование банка 'from_ks' - корреспондентский счет 'from_rs' - расчетный счет 'to_tel' - телефонный номер получателя (формат: +7XXXXXXXXXX, 8XXXXXXXXXX, 7XXXXXXXXXX) 'order_id' - номер заказа (в Вашей системе учета) 'ob_cennost_rub' - сумма объявленной ценности 'nalogka_rub' - сумма наложенного платежа
[in]	hash	Обязательный аргумент

Аргументы ответа

В случае успеха, будет возвращена ссылка на сгенерированный PDF файл печати бланка. Все отправления из массива list будут распечатаны в одном PDF файле. Ссылка действительна 24 часа.

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	link	Ссылка на PDF файл.

PHP скрипт - пример, вызова метода print_f7p

Будет доступен после регистрации.

---

API. Метод print_f116. Печать сопроводительного бланка ф.116

Доступ с аутентификацией по API ключу + API паролю. Все аргументы запроса обязательны.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	print_f116
[in]	f116_onepage	Значение 1 или 0. Если 1, то форма 116 печатается на 1 листе А4, иначе на двух листах А5
[in]	print0	Значение 1 или 0. Если 1, то нулевая объявленная ценность и наложенный платеж печатается как 0 руб., иначе остается пустое место
[in]	list	Массив данных о почтовых отправлениях закодированный JSON. Данные параметры печатаются без проверки. Что введено, то будет напечатано. Указывайте телефонный номер для отправления уведомлений по СМС, по факту прихода отправления в почтовое отделение (в разработке) 'from_country' - страна места отправления 'from_index' - почтовый индекс места отправления 'from_state' - область/регион 'from_city' - город/населенный пункт 'from_addr' - обратный адрес отправителя (улица, дом, квартира/офис) 'from_fio' - ФИО или наименование организации отправителя 'p_seriya' - серия паспорта 'p_nomer' - номер паспорта 'p_vidan' - дата выдачи (формат: ДД.ММ.ГГГГ) 'p_vidal' - наименования учреждения выдавшего паспорт 'to_country' - страна места получения 'to_index' - почтовый индекс получателя 'to_state' - область/регион 'to_city' - город/населенный пункт 'to_addr' - адрес получателя (улица, дом, квартира/офис) 'to_fio' - ФИО или наименование организации получателя 'to_tel' - телефонный номер получателя (формат: +7XXXXXXXXXX, 8XXXXXXXXXX, 7XXXXXXXXXX) 'order_id' - номер заказа (в Вашей системе учета) 'ob_cennost_rub' - сумма объявленной ценности 'nalogka_rub' - сумма наложенного платежа
[in]	hash	Обязательный аргумент

Аргументы ответа

В случае успеха, будет возвращена ссылка на сгенерированный PDF файл печати бланка. Все отправления из массива list будут распечатаны в одном PDF файле. Ссылка действительна 24 часа.

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	link	Ссылка на PDF файл.

PHP скрипт - пример, вызова метода print_f116

Будет доступен после регистрации.

---

API. Метод print_f112. Печать бланка почтового перевода ф.112эн

Доступ с аутентификацией по API ключу + API паролю. Все аргументы запроса обязательны.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	print_f112
[in]	f113_oborot	Значение 1 или 0. Если 1, тогда оборотная сторона бланка ф.112 печатается, иначе - нет
[in]	nalogka_ur_lico_cb	Значение 1 или 0. Если 1, тогда заполняются поля для перевода на банковский счет, иначе - нет
[in]	list	Массив данных о почтовых отправлениях закодированный JSON. Данные параметры печатаются без проверки. Что введено, то будет напечатано. Указывайте телефонный номер для отправления уведомлений по СМС, по факту прихода отправления в почтовое отделение (в разработке) 'from_country' - страна места отправления 'from_index' - почтовый индекс места отправления 'from_state' - область/регион 'from_city' - город/населенный пункт 'from_addr' - обратный адрес отправителя (улица, дом, квартира/офис) 'from_fio' - ФИО или наименование организации отправителя 'from_inn' - ИНН получателя (ООО или ИП) 'from_bik' - БИК Банка, в котором открыт счет 'from_bank' - наименование банка 'from_ks' - корреспондентский счет 'from_rs' - расчетный счет 'to_country' - страна места получения 'to_index' - почтовый индекс получателя 'to_state' - область/регион 'to_city' - город/населенный пункт 'to_addr' - адрес получателя (улица, дом, квартира/офис) 'to_fio' - ФИО или наименование организации получателя 'to_tel' - телефонный номер получателя (формат: +7XXXXXXXXXX, 8XXXXXXXXXX, 7XXXXXXXXXX) 'order_id' - номер заказа (в Вашей системе учета) 'ob_cennost_rub' - сумма объявленной ценности 'nalogka_rub' - сумма наложенного платежа
[in]	hash	Обязательный аргумент

Аргументы ответа

В случае успеха, будет возвращена ссылка на сгенерированный PDF файл печати бланка. Все отправления из массива list будут распечатаны в одном PDF файле. Ссылка действительна 24 часа.

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	link	Ссылка на PDF файл.

PHP скрипт - пример, вызова метода print_f112

Будет доступен после регистрации.

---

API. Метод print_f113. Печать бланка почтового перевода ф.113эф

Доступ с аутентификацией по API ключу + API паролю. Все аргументы запроса обязательны.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	print_f113
[in]	f113_oborot	Значение 1 или 0. Если 1, тогда оборотная сторона бланка ф.113 печатается, иначе - нет
[in]	nalogka_ur_lico_cb	Значение 1 или 0. Если 1, тогда заполняются поля для перевода на банковский счет, иначе - нет
[in]	list	Массив данных о почтовых отправлениях закодированный JSON. Данные параметры печатаются без проверки. Что введено, то будет напечатано. Указывайте телефонный номер для отправления уведомлений по СМС, по факту прихода отправления в почтовое отделение (в разработке) 'from_country' - страна места отправления 'from_index' - почтовый индекс места отправления 'from_state' - область/регион 'from_city' - город/населенный пункт 'from_addr' - обратный адрес отправителя (улица, дом, квартира/офис) 'from_fio' - ФИО или наименование организации отправителя 'from_inn' - ИНН получателя (ООО или ИП) 'from_bik' - БИК Банка, в котором открыт счет 'from_bank' - наименование банка 'from_ks' - корреспондентский счет 'from_rs' - расчетный счет 'to_country' - страна места получения 'to_index' - почтовый индекс получателя 'to_state' - область/регион 'to_city' - город/населенный пункт 'to_addr' - адрес получателя (улица, дом, квартира/офис) 'to_fio' - ФИО или наименование организации получателя 'to_tel' - телефонный номер получателя (формат: +7XXXXXXXXXX, 8XXXXXXXXXX, 7XXXXXXXXXX) 'order_id' - номер заказа (в Вашей системе учета) 'ob_cennost_rub' - сумма объявленной ценности 'nalogka_rub' - сумма наложенного платежа
[in]	hash	Обязательный аргумент

Аргументы ответа

В случае успеха, будет возвращена ссылка на сгенерированный PDF файл печати бланка. Все отправления из массива list будут распечатаны в одном PDF файле. Ссылка действительна 24 часа.

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	link	Ссылка на PDF файл.

PHP скрипт - пример, вызова метода print_f113

Будет доступен после регистрации.

---

API. Метод parcel. Отслеживание отправление по коду РПО

Доступ с аутентификацией по API ключу + API паролю. Обязательный аргумент (помимо основных) - rpo. Остальные параметры - дополнительные, если Вам понадобится пользоваться нашим личным кабинетом для наглядного отслеживания посылок.

Как работает сервис по отслеживанию? Вы добавляете нужные РПО к отслеживанию вызывая метод parcel с нужным rpo. При вызове метода parcel с номером РПО который не был добавлен к отслеживанию ранее, Вы получите сообщение об успешно выполенной операции и пустые статусы status0, status1. Ваш номер РПО добавлен в очередь на отслеживание. Сервис обновляет информацию о каждом отправлении 3 раза в сутки. Первое обновление каждого нового номера РПО будет в интервале от 5 до 30 минут. Через 30 минут вызываете данный метод parcel с номером РПО добавленным ранее и получаете обновленный статус отправления и всю историю прохождения. Если статусы пустые - скорее всего еще не обновилась информация в базе Почты России по данному отправлению.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	parcel
[in]	rpo	Идентификатор отправления (РПО). Обязательный параметр.
[in]	from_country	страна места отправления
[in]	from_index	почтовый индекс места отправления
[in]	from_state	область/регион
[in]	from_city	город/населенный пункт
[in]	from_addr	обратный адрес отправителя (улица, дом, квартира/офис)
[in]	from_fio	ФИО или наименование организации отправителя
[in]	p_seriya	серия паспорта
[in]	p_nomer	номер паспорта
[in]	p_vidan	дата выдачи (формат: ДД.ММ.ГГГГ)
[in]	p_vidal	наименования учреждения выдавшего паспорт
[in]	nalogka_ur_lico_cb	Значение 1 или 0. Если 1, тогда заполняются поля для перевода на банковский счет, иначе - нет
[in]	from_inn	ИНН получателя (ООО или ИП)
[in]	from_bik	БИК Банка, в котором открыт счет
[in]	from_bank	наименование банка
[in]	from_ks	корреспондентский счет
[in]	from_rs	расчетный счет
[in]	to_country	страна места получения
[in]	to_index	почтовый индекс получателя
[in]	to_state	область/регион
[in]	to_city	город/населенный пункт
[in]	to_addr	адрес получателя (улица, дом, квартира/офис)
[in]	to_fio	ФИО или наименование организации получателя
[in]	to_tel	телефонный номер получателя (формат: +7XXXXXXXXXX, 8XXXXXXXXXX, 7XXXXXXXXXX)
[in]	order_id	номер заказа (в Вашей системе учета)
[in]	ob_cennost_rub	сумма объявленной ценности
[in]	nalogka_rub	сумма наложенного платежа
[in]	rpo_send_sms	Уведомление по СМС (сервис в разработке). Значения: 'noone' - не уведомлять 'to' - уведомлять только получателя (по номеру телефона to_tel) 'from' - уведомлять только отправителя (по номеру телефона из личного кабинета) 'tofrom' - уведомлять и получателя и отправителя
[in]	hash	Обязательный аргумент

Аргументы ответа

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	rpo	Идентификатор посылки РПО
[out]	status0	Текущий статус посылки часть 1
[out]	status1	Текущий статус посылки часть 2
[out]	index	Текущий индекс места обработки
[out]	place	Название текущего места обработки
[out]	date	Время текущего статуса в формате ДД.ММ.ГГГГ
[out]	date_num	Время текущего статуса в формате UNIX TIME STAMP
[out]	rpo_status_error	Накапливаемая ошибка обновления. Накапливается в случае, если вы ввели номер которого нет в базе Почты России и через некоторое время отслеживание данного РПО прекращается
[out]	rpo_send_sms	Кому отправляются уведомления по СМС
[out]	log_json	История прохождения отправления. Треклист. Массив закодирован в строку JSON и состоит из элементов: 'status0' - Статус посылки часть 1 'status1' - Статус посылки часть 2 'index' - Индекс места обработки 'place' - Название места обработки 'date' - Время статуса в формате ДД.ММ.ГГГГ 'date_num' - Время статуса в формате UNIX TIME STAMP
[out]	rpo	Идентификатор посылки РПО

PHP скрипт - пример, вызова метода parcel (отслеживания почтового отправления)

Будет доступен после регистрации.

---

API. Метод print_f103. Печать списка почтовых отправлений ф.103

Доступ с аутентификацией по API ключу + API паролю. Все аргументы запроса обязательны.

Аргументы запроса

[in]	apikey	API ключ Вашего аккаунта.
[in]	method	print_f103
[in]	list	Массив данных о почтовых отправлениях закодированный JSON. 'to_country' - страна места получения 'to_index' - почтовый индекс получателя 'to_state' - область/регион 'to_city' - город/населенный пункт 'to_addr' - адрес получателя (улица, дом, квартира/офис) 'to_fio' - ФИО или наименование организации получателя 'ob_cennost_rub' - сумма объявленной ценности 'nalogka_rub' - сумма наложенного платежа
[in]	vid_rpo	Поле на первой странице бланка: "Вид и категория РПО"
[in]	otpravitel	Поле на первой странице бланка: "Отправитель"
[in]	mesto_priema	Поле на первой странице бланка: "Наименование и индекс места приема"
[in]	hash	Обязательный аргумент

Аргументы ответа

В случае успеха, будет возвращена ссылка на сгенерированный PDF файл печати бланка. Все отправления из массива list будут распечатаны в одном PDF файле. Ссылка действительна 24 часа.

[out]	msg	Сообщение о выполнении действия в виде массива с ключами. 'type' - тип сообщения (error - ошибка, done - успешно). 'text' - текстовое сообщение.
[out]	link	Ссылка на PDF файл.

PHP скрипт - пример, вызова метода print_f103

Будет доступен после регистрации.