Партнерка на США и Канаду по недвижимости, выплаты в крипто

  • 30% recurring commission
  • Выплаты в USDT
  • Вывод каждую неделю
  • Комиссия до 5 лет за каждого referral

Описание API Smart Post

Оглавление

Перечень изменений        2

1.        Принципы использования API        3

Параметры запроса        3

Параметры авторизации для тестового доступа        3

Параметры ответа        3

Примеры        3

2.        Работа со справочниками (имя сервиса: catalog)        4

Функция получения списка областей GetRegions        4

Функция получения списка городов GetCities        4

Функция получения списка улиц города GetStreet        5

Функция получения типов (форматов) посылок GetCargoTypes        6

Функция получения списка тарифов GetServices        6

Функция получения списка временных интервалов GetDeliveryIntervals        7

Функция получения списка дополнительных услуг GetOptions        7

Функция получения списка статусов доставки GetDeliveryStatuses        8

Функция создания контрагента CreateLogin* (системная)        8

Функция создания контрагента CreateCounterparty        9

3.        Работа с документами (имя сервиса: document)        10

Функция расчета стоимости доставки CalculateDocument        10

НЕ нашли? Не то? Что вы ищете?

Функция создания отправления CreateDocument        11

Функция регистрации заявки на забор CreateTransferCargoRequest        13

4.        Печать документов (имя сервиса: print)        15

Функция получения печатной формы накладной(PrintDocument)        15

Функция получения стикеров накладной(PrintMarkings)        15

Функция получения печатной формы заявки на забор (PrintTransferCargoRequest)        15

5.        Работа со статусами (имя сервиса: track)        16

Функция получения актуального статуса отправлений GetDocumentStatus        16

Функция получения истории статусов отправлений GetDocumentStatusHistory        16

6.        Отчеты (имя сервиса: report)        18

Общий отчет GetGeneralReport        18

Параметры        18

Ответ        18

Пример        18

Перечень изменений


Дата

Версия

Описание изменений

12.07.2018

0.5

Добавлены функции:

    GetCargoTypes GetServices GetOptions CalculateDocument

13.07.2018

0.6

Добавлены функции:

    GetDeliveryStatuses CreateCounterparty

Обновлена функция CreateDocument (реквизиты сервиса и дополнительные услуги)

16.07.2018

0.7

Добавлены функции:

    GetDeliveryIntervals GetGeneralReport

Изменена функция GetDocumentStatus (добавлена возможность передавать список номеров отправлений)

Изменена функция CreateDocument (добавлен блок Payer, Description)

26.07.2018

0.8

Обновлена функция CreateDocument (при регистрации накладной возвращает стоимость доставки DeliveryCost)

Обновлена функция GetServices

Обновлена функция GetDeliveryIntervals

Обновлена функция GetDocumentStatusHistory (добавлена возможность выбора только измененных статусов за период)

28.07.2018

0.9

Упорядочены запросы/ответы по функциям

Обновлена функция CreateTransferCargoRequest (добавлен вид операции)

30.07.2018

0.10

Обновлена функция GetDocumentStatusHistory (добавлена информация по актуальному статусу)

Обновлена функция GetCities (добавлена информация по районам и признак наличия доставки в населенный пункт)

13.08.2018

1.00

Добавлена функция CreateCounterparty

Обновлена функция CreateDocument (добавлены габаритные характеристики посылки, добавлена возможность передавать контрагента)

Принципы использования API

Для вызовов функций необходимо отправить POST-запрос на адрес

http://95.158.18.138:82/SmartPost/hs/api/{имя_сервиса}/ (тестовый доступ) со следующими полями:

Заголовки:

Header: 'Authorization: Basic YXBpOg=='

Параметры запроса

№ п/п

Название параметра

Описание

1

login

Идентификатор клиента

2

key

Ключ доступа

3

method

Название функции

4

data

JSON-файл с данными (описание параметров и результата работы описаны в соответствующем разделе)

Параметры авторизации для тестового доступа

№ п/п

Название параметра

Описание

1

login

test

2

key

test

Параметры ответа

№ п/п

Название параметра

Описание

1

success

true/false – результат выполнения

2

data

JSON-файл с данными выполнения (описание параметров и результата работы описаны в соответствующем разделе)

3

error_code

строка, Описание ошибки

Примеры

login=test&key=test&method=GetRegions&data={ } login=test&key=test&method=PrintDocument&data={"DocumentNumber":"180000523"}



Работа со справочниками (имя сервиса: catalog)

Функция получения списка областей GetRegions


№ п/п

Название параметра

Описание

Без параметров

Ответ:

{

"success":true,

"data":[

{

"Description":" Київська",

"DescriptionEn":"",

"Ref":" 000000011"

}

],

"error_code":[]

}

Функция получения списка городов GetCities


№ п/п

Название параметра

Описание

1

FindByString

Поиск города по названию. Если не указывать этот параметр, функция возвратит весь список городов.

2

AreaRef

Идентификатор области (для отбора по области)

Ответ:

Название параметра

Описание

RegionDescription

Наименование области

RegionDescriptionEn

Наименование области (англ.)

RegionRef

Идентификатор области

DistrictDescription

Наименование района

DistrictDescriptionEn

Наименование района (англ.)

DistrictRef

Идентификатор района

Description

Наименование

DescriptionEn

Наименование (англ.)

Ref

Идентификатор

Active

Булево – Доставка производится


Пример:

{

"FindByString":"Киев"

"AreaRef":" 000000011"

}

Ответ:

{

"success":true,

"data":[

{

"Description":" Київ",

"DescriptionEn":"",

"Ref":" 000008895"

}

],

"error_code":[]

}

Функция получения списка улиц города GetStreet


№ п/п

Название параметра

Описание

1

FindByString

Поиск улицы по названию. Если не указывать этот параметр, функция возвратит весь список улиц города.

2

CityRef

Идентификатор города

Пример:

{

"FindByString":"Хрещатик",

" CityRef":"000008895"

}

Ответ:

{

"success":true,

"data":[

{

"Description":" вул. Хрещатик",

"Ref":" 000089188"

}

],

"error_code":[]

}

Функция получения типов (форматов) посылок GetCargoTypes


№ п/п

Название параметра

Описание

Без параметров

Фиксированный массив:

    "Docs" -"Документы" "Parcel" - "Посылка" "Cargo" - "Груз" "Pallet" - "Паллета"

Ответ:

{

"success":true,

"data":[

{

" CargoType":" Docs",

" CargoDescription":" Документы"

}

],

"error_code":[]

}

Функция получения списка тарифов GetServices


№ п/п

Название параметра

Описание

Без параметров

Ответ:

ServiceName

ServiceCode

Ref

PickUpIsAllowed

Есть забор (булево)

DeliveryToADayIsAllowed

Есть доставка день в день (булево)

DeliveryInIntervalIsAllowed

Есть выбор интервалов доставки (булево)

{

"success":true,

"data":[

{

"ServiceName":" вул. Хрещатик",

"ServiceCode":" 000001",

"Ref":" ------------------------------"

}

],

"error_code":[]

}

Функция получения списка временных интервалов GetDeliveryIntervals


Название параметра

Описание

Без параметров

Ответ:

Start

Начало интервала (время)

End

Конец интервала (время)

Close

Время закрытия (позже этого времени нельзя выбирать это окно)

Type

Тип интервала (строка)

    PickUp – забор Delivery - доставка

{

"success":true,

"data":[

{

" DeliveryIntervalName":" вул. Хрещатик",

" DeliveryIntervalCode":" 000001",

"Ref":" ------------------------------",

"Start":"",

"End":" ------------------------------",

"Type":"PickUp"

}

],

"error_code":[]

}

Функция получения списка дополнительных услуг GetOptions


№ п/п

Название параметра

Описание

Без параметров

Ответ:

{

"success":true,

"data":[

{

"OptionName":"Подъем на этаж",

"OptionCode":"000000006",

"Ref":" ------------------------------"

}

],

"error_code":[]

}

Функция получения списка статусов доставки GetDeliveryStatuses


№ п/п

Название параметра

Описание

Без параметров

Ответ:

{

"success":true,

"data":[

{

" StatusName":" 1. Доручено",

" StatuseCode":" 000000009",

"Ref":" ------------------------------"

}

],

"error_code":[]

}

Функция создания контрагента CreateLogin* (системная)


№ п/п

Название параметра

Описание

Login

Логин

Key

Ключ контрагента

Пример:

Ответ:

{

"success":true,

"data":[],

"error_code":[]

}

Функция создания контрагента Create Counterparty


№ п/п

Название параметра

Описание


Ref

Идентификатор контрагента (пустой или полученный реннее, для изменения существующего контрагента)

Name

Название контрагента

EDRPOU

Код по ЕДРПОУ юр. лица (только цифры, 5-8 символов).

INN

Код ИНН юр. лица (только цифры).

Пример:

Ответ:



Работа с документами (имя сервиса: document)

Функция расчета стоимости доставки CalculateDocument

Параметры:

№ п/п

Название параметра

Описание

Данные получателя

ReceiverCountry

Страна получателя (идентификатор)

ReceiverArea

Область получателя (идентификатор)

ReceiverCity*

Город получателя (идентификатор)

Floor

Этаж (число) – при заказе доп. услуги «Подъем на этаж»

Lift

Признак наличия лифта (булево) – при заказе доп. услуги «Подъем на этаж»

Данные отправителя

SenderCountry

Страна отправителя (идентификатор)

SenderArea

Область получателя (идентификатор)

SenderCity*

Город отправителя (идентификатор)

Данные заказа

ServiceType*

Тип доставки

    «WW» – Склад-Склад «WD» – Склад-Адрес «DW» – Адрес-Склад «DD» – Адрес-Адрес

Service*

Тип услуги (тарифа)

CargoType*

Вид груза

Weight*

Вес

Volume*

Объем

Seats*

Количество мест

Value*

Оценочная стоимость

COD

Сумма наложенного платежа (предоплатные – с 0 сумой)

DeliveryDate*

Дата доставки (дата)

DeliveryInterval

Окно доставки

Options

Список дополнительных услуг

Options:

№ п/п

Название параметра

Описание

Option*

Дополнительная услуга (идентификатор или код)

Возвращает:

№ п/п

Название параметра

Описание

1

success

Флаг успеха операции

2

error_code

Описание ошибки, если операция не успешна

3

data

Структура данных

DeliveryCost

Стоимость доставки

Пример ответа

{"success":true,

"error_code":"",

"data":

{"DeliveryCost":150}

}

Функция создания отправления CreateDocument

Параметры:

№ п/п

Название параметра

Описание

ParcelNumber

Номер ТТН (передается при изменении ранее созданной)

Данные получателя

Receiver*

Получатель

ReceiverPhone*

Телефон получателя

ReceiverCountry

Страна получателя (идентификатор)

ReceiverArea*

Область получателя (идентификатор)

ReceiverCity*

Город получателя (идентификатор)

ReceiverStreet*

Улица получателя (идентификатор)

ReceiverHouse*

Дом адреса получателя

ReceiverFlat*

Квартира адреса получателя

Floor

Этаж (число) – при заказе доп. услуги «Подъем на этаж»

Lift

Признак наличия лифта (булево) – при заказе доп. услуги «Подъем на этаж»

ReceiverZip

Индекс адреса получателя

Данные  отправителя

Sender

Отправитель

Counterparty

Идентификатор ранее зарегистрированного контрагента (юр. лица), если не заполнен – соответствует отправителю

SenderPhone

Телефон отправителя

SenderCountry

Страна отправителя (идентификатор)

SenderArea*

Область получателя (идентификатор)

SenderCity*

Город отправителя (идентификатор)

SenderStreet*

Улица отправителя (идентификатор)

SenderHouse*

Дом отправителя

SenderFlat

Квартира отправителя

SenderZip

Индекс отправителя

Данные заказа

OrderNumber

Номер заказа отправителя

ServiceType*

Тип доставки

    «WW» – Склад-Склад «WD» – Склад-Адрес «DW» – Адрес-Склад «DD» – Адрес-Адрес

Service*

Тип услуги (тарифа)

CargoType*

Вид груза

DeliveryDate*

Дата доставки (дата)

DeliveryInterval

Окно доставки

Payer

Плательщик доставки (Sender/Recipient/ThirdPerson)

Weight *

Вес

Volume*

Объем

Seats*

Количество мест

Value*

Оценочная стоимость

COD

Сумма наложенного платежа

Description

Описание вложимого

Notes

Комментарии клиента

Options

Список дополнительных услуг

Places

Массив содержимого посылки

Options:

№ п/п

Название параметра

Описание

Option*

Дополнительная услуга (идентификатор или код)

Places:

№ п/п

Название параметра

Описание

Item*

Название

CustomerCode

Код товара

Quantity*

Количество

Weight*

Вес, в кг.

VolumeWeight

Объемный вес

Volume

Объем

Length

Длина

Width

Ширина

Height

Высота

Value*

Оценочная стоимость

Возвращает:

№ п/п

Название параметра

Описание

1

success

Флаг успеха операции

2

error_code

Описание ошибки, если операция не успешна

3

data

Структура данных

ParcelNumber

Номер ТТН

OrderNumber

Номер заказа отправителя

DeliveryCost

Стоимость доставки (число)

Пример ответа

{"success":true,

"error_code":"",

"data":

{" ParcelNumber":"000150619"}

}

Функция регистрации заявки на забор CreateTransferCargoRequest


Регистрирует заявку на забор груза для ранее созданных отправлений.

Параметры:

№ п/п

Название параметра

Описание

RequestNumber

Номер заявки (передается при изменении ранее созданной)

SenderRequestNumber

Номер заявки отправителя

PickUpDate*

Плановая дата забора

PickUpInterval*

Плановое окно забора

ContactName*

Контактное лицо отправителя

ContactPhone*

Телефон контактного лица

ContactEMail

Электронная почта контактного лица

Country

Страна отправителя (идентификатор)

Area

Область получателя (идентификатор)

City*

Город отправителя (идентификатор)

Street*

Улица отправителя (идентификатор)

House*

Дом отправителя

Flat

Квартира отправителя

Operation

Строка, фиксированный масив, по-умолчанию «update»

    «add» - добавить отправление (список) в заявку «remove» - удалить отправление (список) из заявки «update» - обновить заявку списком отправлений (ранее включенные будут удалены из заявки) «clear» - удалить все отправления из заявки

Parcels*

Массив идентификаторов посылок

Ответ:

№ п/п

Название параметра

Описание

1

RequestNumber

Номер заявки

2

SenderRequestNumber

Номер заявки отправителя


Печать документов (имя сервиса: print)

Функция получения печатной формы накладной(PrintDocument)


№ п/п

Название параметра

Описание

1

DocumentNumber

Номер ТТН

Возвращает pdf-файл.

Функция получения стикеров накладной(PrintMarkings)


№ п/п

Название параметра

Описание

1

DocumentNumber

Номер ТТН

2

Zebra

Булево, признак печати на термопринтер, иначе лист А4

Возвращает pdf-файл.

Функция получения печатной формы заявки на забор (PrintTransferCargoRequest)


№ п/п

Название параметра

Описание

1

DocumentNumber

Номер заявки

Возвращает pdf-файл.



Работа со статусами (имя сервиса: track)

Функция получения актуального статуса отправлений GetDocumentStatus


№ п/п

Название параметра

Описание

1

ParcelNumber

Номер отправителя (или список через запятую)

Пример:

{

"ParcelNumber":"001590000"

}

Ответ:

{

"success":true,

"data":[

{

"ParcelNumber":" 001590000",

"OrderNumber":" YN1800156",

"OrderStatusID":"000000003",

"OrderStatus":"Зарегистрировано",

"ChangeDate":"01.08.2018 11:25:45"

],

"error_code":[]

}

Функция получения истории статусов отправлений GetDocumentStatusHistory


№ п/п

Название параметра

Описание

1

ParcelNumber

Номер ТТН (или список через запятую) (если не заполнен – все измененные статусы за выбранный период)

2

StartDate

Начало периода выборки статусов (если заполнен – только статусы измененные за период)

3

EndDate

Конец периода выборки статусов (если заполнен – только статусы измененные за период)

Пример:

{

"ParcelNumber":"001590000"

}

Ответ:

{

"success":true,

"data":[

{

"ParcelNumber":" 001590000",

" OrderNumber":" YN1800156"

"StatusHistory":[

{"OrderStatusID":"000000003",

"OrderStatus":"Зарегистрировано",

"ChangeDate":"01.05.2018 11:25:45"

},

{"OrderStatusID":"000000005",

"OrderStatus":"Доставлено",

"ChangeDate":"08.05.2018 11:25:45"

}

]

],

"error_code":[]

}


Отчеты (имя сервиса: report)

Общий отчет GetGeneralReport


Параметры

Название параметра

Описание

Без параметров

Ответ

COD

Сумма расчетов по COD

Service

Сумма расчетов по услугам доставки

Пример

{

"success":true,

"data":{

"COD":120.00,

"Service":50.00

},

"error_code":[]

}