Документационная схема API доступна по данной ссылке
Адрес сервиса: https://online.smartlombard.ru/api/exchange/v1
Ответом метода является json - массив объектов pawn_ticket.
Возможные передаваемые GET параметры
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| open_date_begin | string (пример: 01.03.2023) |
Нет | query | Начальная дата открытия залоговых билетов (Выдает все залоговые билеты, дата открытия, которых больше либо равно значению данного поля) |
| open_date_end | string (пример: 01.04.2023) |
Нет | query | Завершающая дата открытия залоговых билетов (Выдает все залоговые билеты, дата открытия, которых меньше либо равно значению данного поля) |
| close_date_begin | string (пример: 01.03.2023) |
Нет | query | Начальная дата закрытия залоговых билетов (Выдает все залоговые билеты, дата закрытия, которых больше либо равно значению данного поля) |
| close_date_end | string (пример: 01.04.2023) |
Нет | query | Завершающая дата закрытия залоговых билетов (Выдает все залоговые билеты, дата закрытия, которых меньше либо равно значению данного поля) |
| end_date_begin | string (пример: 01.03.2023) |
Нет | query | Начальная дата предполагаемого закрытия залоговых билетов (Выдает все залоговые билеты, дата предполагаемого закрытия, которых больше либо равно значению данного поля) |
| end_date_end | string (пример: 01.04.2023) |
Нет | query | Завершающая дата предполагаемого закрытия залоговых билетов (Выдает все залоговые билеты, дата предполагаемого закрытия, которых меньше либо равно значению данного поля) |
| status | string пример: ‘2,3’ |
Нет | query | Множественный выбор из массива состояний залогового билета: 1 - На реализации (не используемый) 2 - Открыт 3 - Просрочен 4 - Просрочен (готов к продаже) 5 - Закрыт |
| workplace_id | integer (пример: 890) |
Нет | query | ID филиала (Если пользователь не суперадмин то только филиалы доступные пользователю) |
| clients | string (пример: '79,80') |
Нет | query | Множественный выбор из массива ID клиентов (через запятую) |
Результат: json - массив из oбъектов pawn_ticket
Ответом метода являются данные залогового билета по ID.
Передаваемый URL параметр (URL)
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| pawn_ticket_id | integer (пример: 56) |
Да | path | ID - залогового билета (сквозной ID) |
Результаты: json - объект pawn_ticket.
- id - ID залогового билета (сквозной ID)
- pawn_chain_id - ID цепочки билетов (сквозной ID)
- document_number - Полный номер залогового билета
- tariff_id - ID тарифа (сквозной ID)
- loan_amount - Сумма займа
- currency_code - Текстовый код валюты по ISO 4217
- RUB - рубль
- UAH - гривна
- KZT - тенге
- GEL - лари
- MDL - лей
- LVL - лат
- TMM - манат
- KGS - сом
- TJS - сомони
- LTL - лит
- EUR - евро
- USD - доллар
- AMD - драм
- duration - Срок займа, дней
- paid_percents - Сумма оплаченных процентов (Как на вкладке Каталог - Залоговые билеты)
- accrued_percent - Сумма начисленных процентов (Как на вкладке Каталог - Залоговые билеты)
- UTC - Всемирное координированное время
- open_date - Дата открытия залогового билета
- close_date - Фактическая дата закрытия. Возвращается только если залоговый билет закрыт.
- end_date - срок окончания по залоговому билету
- comment - Комментарий
- status - состояние залогового билета
Возможные состояния залогового билета:
- 1 - На реализации (не используемый)
- 2 - Открыт
- 3 - Просрочен
- 4 - Просрочен (готов к продаже)
- 5 - Закрыт
- entity_id - id ЮЛ билета (сквозной ID)
- workplace_id - id филиала
- client_natural_person_id - id клиента (Физ. лица)
- client_legal_person_id - id клиента (ЮЛ)
- pawn_ticket_debt - Задолженность по залоговому билету
- percents_to_pay - Задолженность по процентам
- commission_sum - Комиссия банка
- sum_debt - Общая задолженность по залогому билету
- online_prolongation_url - Ссылка на оплату процентов по залоговому билету
Ответом метода являются данные залоговых имуществ по ID залогового билета.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| pawn_ticket_id | integer (пример: 56) |
Да | path | ID - залогового билета (сквозной ID) |
Результат:
Ответом метода являются данные по операциям. Метод возвращает операцию в том виде, как она отображается странице “операции”.
Метод возвращает json - массив объектов операций - operations.
Передаваемые GET параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| pawn_ticket_id | integer (пример: 763) |
НЕТ | query | ID залогового билета (открываемого, если операция составная, сквозной ID) |
| entity_id | integer (пример: 409) |
НЕТ | query | ID юр. лица (открывающего, ЗБ если операция составная, сквозной ID) |
| account_id | integer (пример: 7963) |
НЕТ | query | ID сотрудника |
| workplace_id | integer (пример: 890) |
НЕТ | query | ID филиала (Если пользователь не суперадмин то только филиалы доступные пользователю) |
| type_operation | string (пример: prolongation, dobor) |
НЕТ | query | Указать тип операций, по которым будет проводится поиск. Варианты: pledge - Залог prolongation - Продление prolongation_online - Онлайн-продление repledge - Перезалог dobor - Добор part_buyout - Частичный выкуп part_buyout_pawn_good - Частичный выкуп имущества sale_pledge - Вывод из залога buyout - Выкуп залогового билета withdraw - Изъятие имущества |
| date_begin | string (пример: 01.03.2023) |
НЕТ | query | Начало периода проведения операции |
| date_end | string (пример: 01.03.2023) |
НЕТ | query | Конец периода проведения операции |
| test_operation | integer (пример: 1) |
НЕТ | query | Признак того, что поиск будет осущевтвляться по тестовым операциям |
Результат: json - массив: operations, состоящий из объектов operation.
Метод позволяет получить данные по ID операции.
Передаваемые параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| operation_id | integer (пример: 596) |
Да | path | Указывается ID операции, если составная то ID операции, открывающей залоговый билет (сквозной ID). |
Результат:
json - объект операции operation
- elementary_operation - объект, содержащий данные по элементарным операциям:
- opening_operation - объект: открывающая операция
- id - ID операции, если составная то ID операции, открывающей залоговый билет (сквозной ID)
- type_operation - Тип операции. Варианты:
- pledge - Залог
- prolongation - Продление
- prolongation_online - Онлайн-продление
- repledge - Перезалог
- dobor - Добор
- part_buyout - Частичный выкуп
- part_buyout_pawn_good - Частичный выкуп имущества
- sale_pledge - Вывод из залога
- buyout - Выкуп залогового билета
- withdraw - Изъятие имущества
- entity_id - ID ЮЛ, открывающего залоговый билет, если операция составная (сквозной ID).
- pawn_ticket_id - ID залогового билета, открываемого, если операция составная (сквозной ID).
- payment_method - Способ расчета, если операция составная, то открывающей операции).
Варианты:
- cash - Касса
- bank_transfer - Безналичный расчет
- bank_account - расчетный счет, для безналичного способа расчета, если операция составная то счет открывающей операции.
- closing_operation - объект: закрывающая операция
- id - ID операции, если составная то ID операции, закрывающей залоговый билет (сквозной ID)
- type_operation - Тип операции.
- entity_id - ID ЮЛ, закрывающего залоговый билет, если операция составная (сквозной ID).
- pawn_ticket_id - ID залогового билета, закрываемого, если операция составная (сквозной ID).
- payment_method - Способ расчета, если операция составная, то закрывающей операции).
Варианты:
- cash - Касса
- bank_transfer - Безналичный расчет
- bank_account - расчетный счет, для безналичного способа расчета, если операция составная то счет закрывающей операции.
- pawn_chain_id (сквозной ID) - ID цепочки операций залогового билета (ID первого билета, в цепочке операций)
- UTC - Всемирное координированное время
- date - Дата операции
- sum - Сумма
- account_id - ID сотрудника, который провел операцию
- workplace_id - ID филиала
- client_natural_person_id - id клиента (Физ. лица)
- client_legal_person_id - id клиента (ЮЛ)
Ответом метода является json - массив элементарных операций elementary_operations, json-объекты elementary_operation.
Передаваемые GET параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| pawn_ticket_id | integer (пример: 763) | НЕТ | query | ID залогового билета операции (сквозной ID) |
| type_operation | string (пример: dobor) Варианты: pledge - Залог prolongation - Продление prolongation_online - Онлайн-продление sale_pledge - Вывод из залога buyout - Выкуп залогового билета withdraw - Изъятие имущества |
НЕТ | query | Тип операций, по которым будет проводиться поиск. Варианты: - pledge; - prolongation; - prolongation_online; - sale_pledge; - buyout; - withdraw. |
| account_id | integer (пример: 7963) |
НЕТ | query | ID сотрудника, проводившего операцию |
| entity_id | integer (пример: 409) |
НЕТ | query | ID юр. лица (сквозной ID) |
| workplace_id | integer (пример: 890) |
НЕТ | query | ID филиала (Если пользователь не суперадминистратор, то только филиалы доступные пользователю) |
| date_begin | string (пример: 01.03.2023) |
НЕТ | query | Начало периода проведения операции |
| date_end | string (пример: 01.03.2023) |
НЕТ | query | Конец периода проведения операции |
Результат: json-массив: elementary_operations, состоящий из json-объектов elementary_operation.
Ответом метода являются данные элементарной операции по ID.
Передаваемые параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| operation_id | integer (пример: 596) |
Да | path | ID - операции (сквозной ID) |
Результат json - объект элементарной операции elementary_operation
- id - ID элементарной операции (сквозной ID)
- pawn_ticket_id - ID залогового билета к которой привязана элементарная операция. (сквозной ID)
- pawn_chain_id - ID цепочки операций залогового билета (ID первого залогового билета в цепочке операций) (сквозной ID)
- type_operation - Тип операции. Варианты:
- pledge - Залог
- prolongation - Продление
- prolongation_online - Онлайн-продление
- sale_pledge - Вывод из залога
- buyout - Выкуп залогового билета
- withdraw - Изъятие имущества
- type_sub_operation - Если текущая операция является частью составной, то в этой переменной будет указан тип составной операции. Варианты:
- repledge - Перезалог
- dobor - Добор
- part_buyout - Частичный выкуп
- part_buyout_pawn_good - Частичный выкуп имущества
- payment_method - Способ расчета. Варианты
- cash - Касса
- bank_transfer - Безналичный расчет
- bank_account - расчетный счет (если способ расчета безналичный)
- UTC - Всемирное координированное время
- date - Дата операции
- sum - Сумма
- entity_id - ID ЮЛ (сквозной ID)
- account_id - ID сотрудника, который провел операцию
- workplace_id - ID филиала
- client_natural_person_id - id клиента (Физ. лица)
- client_legal_person_id - id клиента (ЮЛ)
Ответом метода является список имуществ. Можно выбрать фильтрацию и получить соответствующий список id имуществ.
Возможные передаваемые параметры фильтрации:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| category_id | integer (пример: 15) |
Нет | query | ID Категории или ID подкатегории или ID младшей подкатегории |
| workplace_id | integer (пример: 890) |
Нет | query | ID филиала, где находится имущество (Если пользователь не суперадмин, то только филиалы доступные пользователю) |
| status | integer (пример: 1) |
Нет | query | Варианты: * 1 - На реализации (!Статус пока в разработке!); * 2 - Реализован (!Статус пока в разработке!); * 3 - Заложен; * 4 - Заложен (просрочен); * 5 - Выкуплен; * 6 - Готов к продаже; * 7 - Выведен из залога; * 8 - Изъят. |
Результат: json-массив pawn_goods из json-объектов pawn_good.
Ответом метода являются json-объект с данными залогового имущества pawn_good по ID.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| pawn_good_id | integer (пример: 56) |
Да | path | ID имущества (сквозной ID) |
Результат pawn_good - объект:
- id - ID имущества (сквозной ID)
- article - ID имущества из программы
- name - Наименование имущества
- serial_number - Серийный номер (не для всех типов категорий)
- estimate_price - Сумма оценки
- currency_code - Текстовый код валюты по ISO 4217
- RUB - рубль
- UAH - гривна
- KZT - тенге
- GEL - лари
- MDL - лей
- LVL - лат
- TMM - манат
- KGS - сом
- TJS - сомони
- LTL - лит
- EUR - евро
- USD - доллар
- AMD - драм
- category_id - ID категории
- type - Тип имущества. Варианты:
- jewelry - Ювелирное изделие.
- vehicle - Транспортное средство.
- phone - Мобильный.
- other - Обычное.
- description - Описание имущества
- comment - Комментарий
- storage - Место хранения
- status - Состояние. Варианты:
- 1 - Реализован (не используется)
- 2 - На реализации (не используется)
- 3 - Заложен
- 4 - Заложен (просрочен)
- 5 - Выкуплен
- 6 - Готов к продаже
- 7 - Выведен из залога
- 8 - Изъят
- workplace_id - id филиала, где находится имущество
- jewelry_extra - массив доп. полей для категории Ювелирное изделие
- manufacturer - Производитель
- uin - УИН
- size - Размер/длина
- metal_name - Наименование металла
- metal_standart_name - Наименование пробы
- weight - Вес, г
- weight_inserts - Вес вставок, г
- product_type - Лом/Изделие
- estimate_inserts - Сумма оценки вставок
- vehicle_extra - массив доп. полей для категории Автотранспорт
- model - Марка, модель
- product_year - Год выпуска
- body_color - Цвет кузова
- reg_number - Гос. номер
- vin - VIN
- engine_description - Модель, № Двигателя
- engine_volume - Рабочий объем двигателя, куб. см.
- chassis_number - Шасси (рама) №
- trailer_number - Кузов (прицеп) №
- pts_number - Серия, номер ПТС
- pts_issued_by - ПТС выдан
- pts_issued_date - Дата выдачи ПТС
- sts_number - Серия, номер СТС
- sts_issued_by - СТС Выдан
- sts_issued_date - Дата выдачи СТС
- phone_extra - массив доп. полей для категории Мобильный телефон
- model - Модель телефона
- memory_size - Встроенная память (размер встроенного хранилища)
- color - Цвет телефона
- ram_size - Оперативная память
- images_links - Массив ссылок на загруженные изображения
Ответом метода является json - массив, natural_persons из json-объектов список клиентов физ. лиц natural_person.
Возможные передаваемые Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| full_name | string (пример: Иванов) |
нет | query | Фильтрация по ФИО (поиск по полям фамилия, имя, отчество) |
| loyalty_card_number | string (пример: 6763) |
Нет | query | Фильтрация по номеру карты постоянного |
| phone | string (пример: +79033080944) |
Нет | query | Фильтрация по номеру телефона |
| inn | string (пример: 213123213) |
Нет | query | Фильтрация по ИНН/ИИН |
Результаты json-массив из объектов клиентов физ. лиц.
Ответом метода являются json-объект natural_person данные клиента по ID.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| client_natural_person_id | integer (пример: 90) |
Да | path | ID клиента |
Результат json - объект natural_person клиент физ. лицо.
- ID - id клиента физ. лица
- last_name - Фамилия клиента
- name - Имя клиента
- patronymic - Отчество клиента
- birth_date - Дата рождения клиента
- address - Адрес регистрации
- actual_address - Фактический адрес проживания
- place_of_birth - Место рождения
- phone - Номер телефона в международном формате
- email - Электронная почта
- photo_links - Ссылки на фотографию клиента в виде массива. Пример:
"photo_link": [{
"full_size": "https://online.smartlombard.ru/img/image1_full_size.jpg",
"preview": "https://online.smartlombard.ru/img/image1_preview.jpg"
}]
- nationality - Гражданство. Числовой код страны в справочнике ОКСМ. Пример: “643”
- inn - ИНН или ИИН (для РК)
- snils - СНИЛС
- additional_info - Дополнительная информация
- warning_message - Предупреждение
- loyalty_card_number - Номер карты постоянного клиента
- loyalty_card_discount - Скидки по картам лояльности
"loyalty_card_discount": {
"discount_lombard": 10, // Скидка на проценты ломбарда, %
"discount_sell": 12, // Скидка при покупке товаров, %
"discount_sell_realization": 13 // Скидка при покупке товаров, принятых на реализацию, %
}
- bonuses - Количество бонусов
Ответом метода является json-массив legal_persons, список json-объектов клиента юридического лица legal_person.
Возможные передаваемые GET Параметры
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| name | string (пример: Ломбард) |
Нет | query | Фильтрация по наименованию организации |
Результаты json-массив объектов legal_person.
Ответом метода являются json-объект клиента юридического лица legal_person.
Параметры
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| client_legal_person_id | integer (пример: 78) |
Да | path | ID ЮЛ |
Результаты json - объект legal_person.
- id - ID клинета ЮЛ
- legal_form - правовая форма
- name - Название ЮЛ
- legal_address - Юридический адрес ЮЛ
- phone - Общий телефон организации
- director_fio - ФИО директора
- chief_accountant_fio - ФИО главного бухгалтера
- inn - ИНН
- kpp - КПП
- ogrn - ОГРН
- okpo - ОКПО
- oktmo - ОКТМО
Результат: json-массив entities состоит из json-объектов entity юридических лиц филиалов (не клиентов).
Ответом метода являются данные юридического лица филиалов по ID.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| entity_id | integer (пример: 409) |
Да | path | ID юр. лица (сквозной ID) |
Результат json - объект entity юридических лиц филиалов (не клиентов).
- id - ID ЮЛ (раздел Управление → Настройки → Реквизиты) (сквозной ID)
- name - Название ЮЛ
- legal_address - Юридический адрес ЮЛ
- phone - Общий телефон организации
- director_fio - ФИО директора
- chief_accountant_fio - ФИО главного бухгалтера
- taxation_system - Система налогообложения
- 1 - ОСНО
- 2 - УСН (Доходы)
- 3 - УСН (Доходы минус расходы)
- 4 - ПСН
- inn - ИНН
- kpp - КПП
- ogrn - ОГРН
- okpo - ОКПО
- oktmo - ОКТМО
- number_in_lombard_register - Номер в реестре ломбардов
- property_insurance_sum - Сумма страховки имущества
- bank_details - банковские реквизиты (Может быть несколько)
- bank_account - р/с
- bank_name - Банк
- сorrespondent_account - к/с
- bik - БИК
Ответом метода является массив, список филиалов. Можно выбрать несколько фильтров и получить данные соответствующих филиалов.
Возможные передаваемые параметры
| Тип параметра | Тип параметра | Обязателен | Тип параметра | Тип параметра |
|---|---|---|---|---|
| state | integer (пример: 2) |
Нет | query | Видимость филиалов 1 - Только активные филиалы 2 - Только скрытые филиалы |
Результат:
Ответом метода являются данные филиала по ID.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| workplace_id | integer (пример: 890) |
Да | path | ID филиала (Если пользователь не суперадмин то только филиалы доступные пользователю) |
Результат json - объект workplace
- id - ID - филиала
- title - Название филиала
- city - Нас. пункт филиала
- address - Адрес филиала
- okato - ОКАТО филиала
- phone - Телефон филиала
- state - Видимость филиала. Варианты:
- 1 - Только активные филиалы
- 2 - Только скрытые филиалы
- image_links - Ссылки на фотографию/логотип в виде массива.
Пример:
{
"image_links": {
"full_size": "https://online.smartlombard.ru/img/image1_full_size.jpg",
"preview": "https://online.smartlombard.ru/img/image1_preview.jpg"
}
}Ответом метода является список докуметов клиента.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| client_natural_person_id | integer (пример: 90) |
Да | path | ID клиента |
Результат:
Ответом метода является данные документа по его ID и ID клиента.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| client_natural_person_id | integer (пример: 90) |
Да | path | ID клиента |
| document_id | integer (пример: 569) |
Да | path | ID документа |
Результаты json - объект natural_person документа клиента.
- type - Тип документа
- series_number - Серия номер
- issued_by - Место выдачи
- issued_date - Дата выдачи
- code_department - Код документа
- note - Примечание
Ответом метода является массив данных по тарифам.
Результат json - массив, объектов:
- id - ID тарифа (сквозной ID)
- name - Название тарифа
- payment_min_sum - Минимальная сумма оплаты
- free_days - Количество первых бесплатных дней
- loyalty_card_allowed - Действует ли карта постоянного клиента
- workplaces_id - Массив ID филиалов, где тариф действует
- comment - Комментарий
- status - Статус тарифа. Варианты:
- 1 - Активен
- 2 - Скрыт
- 3 - Удалён
- option_round_sum_pay - Округления суммы оплаты. Варианты:
- Без округления
- Округлять до 1 знака после запятой
- Округлять до целого значения
- Округлять до значения кратного 10 (в большую сторону)
- alert_exceeding_psk - Предупреждать о превышении ПСК
- duration_mode - Тип срока займа. Варианты:
- произвольное
- выбор из списка
- pawn_period - Cрок займа (дней)
- list - Список периодов срока займа (Массив)
- max - Максимальный срок займа, дней
- max_pawn_sum - Максимальная сумма займа
- round_duration - Округление срока залога (Массив)
- title - Вариант округления:
- без округления
- до срока займа
- своё значение
- value - Своё значение округления
- min_duration_days - Минимальное количество дней залога
- calculation_days - Расчет количества дней. Варианты:
- обычный расчет
- прибавлять дополнительный день
- period_calculation - Тип расчета процентов. Варианты:
- фиксированный
- дифференцированный
- percents_intervals - Процентные ставки (Массив)
- duration_pledge - Процент в зависимости от срока залога
- sum_pledge - Процент в зависимости от суммы залога
- value - Значение
- grace_period_type - Единицы измерения льготного периода. Варианты:
- календарный месяц
- по дням
- grace_period_value - Срок просрочки (льготного периода)
- grace_period_calculation - Тип расчета льготного периода. Варианты:
- фиксированный
- дифференцированный
- grace_period_percents - Процентные ставки льготного периода по займу (Массив)
- duration_pledge - Процент в зависимости от срока залога
- sum_pledge - Процент в зависимости от суммы залога
- value - Значение
- storage_fee - Сумма оплаты хранения
- estimate_cost - Сумма оплаты оценки
- tariff_percents - Процентная ставка по займу
- specific_services - На прочие услуги
{
"duration_pledge": 10,
"sum_pledge": 12,
"value": 13
}Ответом метода является массив объектов данных сотрудников профиля. Можно использовать фильтр по статусу.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| status | integer (пример: 1) |
Да | query | Статус сотрудника: 1 - Действующий 2 - Уволен 3 - Забанен |
Результат JSON массив ID сотрудников профиля:
Описание: Ответом метода являются данные сотрудника по ID.
Параметры:
| Название | Тип | Обязателен | Тип параметрая | Описание |
|---|---|---|---|---|
| account_id | integer (пример: 7963) |
Да | path | ID - Сотрудника |
Результат объект account с данными:
Json - объект account
- id - ID аккаунта
- login - Логин
- full_name - ФИО
- phone - Телефон
- inn - ИНН
- role - Роль
- comment - Комментарий
- status - Варианты:
- 1 - Действующий
- 2 - Уволен
- 3 - Забанен
Ответом метода является список категорий верхнего уровня.
Результаты массив родительских категорий:
- id - ID категории
- name - Название категории
- system_category - Системная ли категория. Варианты:
- 0 - Пользовательская
- 1 - Системная
Ответом метода является список подкатегорий по id категории верхнего уровня.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| category_id | integer (пример: 307) |
Да | path | ID родительской категории |
Результаты массив названий подкатегорий:
- id - ID подкатегории
- name - Название подкатегорий
- system_subcategory - Системная ли подкатегория. Варианты:
- 0 - Пользовательская
- 1 - Системная
Ответом метода является список младших подкатегорий по id категориям верхнего уровня.
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| category_id | integer (пример: 307) |
Да | path | ID родительской категории |
| subcategory_id | integer (пример: 307) |
Да | path | ID родительской подкатегории |
Результаты массив названий подкатегорий:
- id - ID младшей подкатегории
- name - Название младшей подкатегорий
- system_subcategory - Системная ли подкатегория. Варианты:
- 0 - Пользовательская
- 1 - Системна
Метод позволяет получить все места хранения по ID филиала.
Параметр:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| workplace_id | integer (пример: 307) |
Да | query | ID филиала |
Результаты массив названий подкатегорий storages со свойствами:
- id (integer) - ID места хранения
- name (string) - Наименование места хранения
Метод позволяет получить справочники для добавления драгоценных камней.
Результат - json массив справочников для драгоценных камней со свойствами:
- measures_units (array) - Единицы измерения
- measure_unit_id (integer) - ID единицы измерения
- measure_unit_title (string) - Наименования единицы измерения
- gems_types (array) - Типы камней
- type_id (integer) - ID тип камня
- type_title (string) - Наименование типа камня
- cut_type (array) - Массив видов огранки:
- cut_type_id (integer) - ID видов огранки
- cut_type_title (string) - Наименование видов огранки
- color_group (array) Массив групп цвета:
- color_group_id (integer) - ID группа цвета
- color_group_title (string) - Наименование группы цвета
- purity_group (array) Массив групп чистоты:
- purity_group_id (integer) - ID группы чистоты
- purity_group_title (string) - Наименование группы чистоты
Пример ответа:
{
"measures_units": [
{
"measure_unit_id": 56,
"measure_unit_title": "Карат"
}
],
"gems_types": [
{
"type_id": 156,
"type_title": "Бриллиант",
"cut_type": [
{
"cut_type_id": 56,
"cut_type_title": "Бп-25"
}
],
"color_group": [
{
"color_group_id": 56,
"color_group_title": "Сине-зеленый"
}
],
"purity_group": [
{
"purity_group_id": 56,
"purity_group_title": "К1"
}
]
}
]
}Метод позволяет получить json - массив jewelry_gems данных драгоценных камней ID имущества (Ювелирного изделия).
Параметры:
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| pawn_good_id | integer (пример: 307) |
Да | path | ID залогового имущества |
Результат jewelry_gems массив json объектов драгоценных камней со свойствами:
amount (int) - Количество камней
weight (float) - Вес
type_title (string) - Наименование типа камня
cut_type_title (string) - Наименование вида огранки
color_group_title (string) - Наименование группы цвета
purity_group_title (string) - Наименование группы чистоты
measure_unit_title (string) - Наименование единицы измерения
Пример ответа:
{
"amount": 2,
"weight": "1.5",
"type_title": "Бриллиант",
"cut_type_title": "И-73",
"color_group_title": "5",
"purity_group_title": "3",
"measure_unit_title": "г"
}Метод позволяет получить json-массив metals ID и наименования драгоценных металлов.
- metal_id (integer) - ID металла
- metal_title (string) - Наименование металла
Метод позволяет получить массив metals_standarts свойства проб.
| Название | Тип | Обязателен | Тип параметра | Описание |
|---|---|---|---|---|
| metal_id | integer (пример: 307) |
Да | path | ID металла |
Результат массив проб камней metals_standarts со свойствами:
- metal_standart_id (integer) - ID пробы.
- metal_standart_code (string) - Проба в метрической системе.
- metal_standart_name (string) - Наименование пробы.
Если отправленный параметр не соответствует ожидаемому результату. Например:
Возвращается ошибка с кодом - 412 с полями:
- field - имя отправляемого поля
- message - сообщение
Например:
[
{
"field": "workplace_id",
"message": "Некорректный ID филиала"
},
{
"field": "number",
"message": "Неверный формат числа"
},
{
"field": "date",
"message": "Некорректная дата"
}
]Для работы с навигацией или пагинацией, во всех методах предполагающих выводы списков сущностей или ID сущностей, будут отправляться параметры page и limit. limit по-умолчанию = 20, максимальный limit = 100.
| Название | Описание | Тип параметра | По умолчанию | Максимальный |
|---|---|---|---|---|
| page | Текущая страница | query | 1 | - |
| limit | Лимит записей | query | 20 | 100 |
В схеме Open Api, в соответствующих методах эти параметры есть. В описание методов данном документе для экономии места описание этих параметров не включаю.
Для работы с навигацией или пагинацией во всех методах, предполагающих выводы списков сущностей или ID сущностей, в пространстве имен Headers возвращаются параметры:
| name | description | location | type | example |
|---|---|---|---|---|
| Pagination-Page | Текущая страница пагинации | Header | integer | 2 |
| Pagination-PageSize | Количество записей на странице | Header | integer | 20 |
| Pagination-CountRecords | Всего найдено записей | Header | integer | 1700 |
| Pagination-CountPages | Всего страниц для пагинации | Header | integer | 85 |
| Pagination-PreviousPage | Предыдущая страница для пагинации | Header | integer | 1 |
| X-Pagination-NextPage | Следующая страница для пагинации | Header | integer | 3 |
В схеме Open Api, в соответствующих методах эти параметры есть. В описание методов данном документе описание этих параметров отсутствует.
В результате проверок возникли проблемы с тем, что не все решения и программы по работе с API умеют доставать данные из блока header. Поэтому, было решено сделать ещё возврат данных по пагинации, в теле ответа json.
Теперь все методы, которые предполагают возврат списка каких либо объектов возвращают ещё и блок metadata, где в свою очередь 2 объекта:
1. pagination - данные для пагинации (как в header),
2. links - ссылки для создания пагинации, с указанием GET параметров.
Вот пример объекта metadata:
{
"metadata": {
"pagination": {
"page": 3,
"count_records": 100,
"count_pages": 5,
"previous_page": 2,
"next_page": 4,
"page_size": 20
},
"links": {
"self": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods&page=3&limit=20",
"first": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods&page=1&limit=20",
"previous": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods&page=2&limit=20",
"next": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods&page=4&limit=20",
"last": "https://online.smartlombard.ru/api/exchange/v1/pawn_goods&page=5&limit=20"
}
}
}