Эта инструкция предназначена для разработчиков и технических специалистов, которые хотят интегрироваться с Lamoda B2B Platform через REST API. Инструкция по интеграции поможет вам быстро и эффективно подключить наши функциональные возможности к вашему продукту. Следуя этому руководству, вы пройдете основные этапы интеграции, ознакомитесь с требованиями к подключению и узнаете как стабилизироваться в Prod среде.
API-интеграция с Lamoda B2B Platform в зависимости от выбранной модели взаимодействия позволяет партнеру в режиме реального времени:
- Создавать товары;
- Передавать и получать информацию о заказах;
- Передавать информацию о поставках.
Набор обменов FBS
Набор обменов FBO
Процесс API-интеграции состоит из следующих этапов:
Подключение к Demo и Prod окружениям согласно разделу "Требования к подключению".
Тестирование интеграции на Demo окружении.
Стабилизация интеграции на Prod окружении.
❗️ Для подключения к Demo и Prod окружению необходимо запросить у sales-manager ключи авторизации - client_id и client_secret.
Требования к подключению
Общие правила
Взаимодействие с Lamoda B2B Platform реализовано посредством RESTful API поверх протокола HTTPS, используемый формат данных - JSON.В соответствии со стандартом rfc4627 при выполнении запросов к защищенным ресурсам необходимо соблюдать следующие правила:
В заголовке запроса требуется указывать Content-type: application/json;
Тело запроса должно быть в формате JSON и передаваться в Request payload.
JSON-формат подразумевает добавление любого поля — это обратносовместимая операция. Поэтому описанные в разделах интеграционного гида Lamoda B2B Platform Guide обмены могут быть изменены с течением времени: возможно добавление новых полей.
Авторизация
Авторизация в Lamoda B2B Platform осуществляется по протоколу OAuth2. Предварительно для авторизации партнеру необходимо запросить у sales-manager уникальные client_id / client_secret.Для авторизации необходимо выполнить запрос вида:
Live:
curl -X GET 'https://api-b2b.lamoda.ru/auth/token?client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%&grant_type=client_credentials'
Demo:
curl -X GET 'https://api-demo-b2b.lamoda.ru/auth/token?client_id=%CLIENT_ID%&client_secret=%CLIENT_SECRET%&grant_type=client_credentials'
Где %CLIENT_ID% и %CLIENT_SECRET% выданные client_id/client_secret.
В ответе возвращается access_token, действительный в течение суток. Токен авторизации необходимо передавать при выполнении любого запроса к Lamoda B2B Platform.
Генерация нескольких токенов авторизации
Допускается генерация нескольких токенов авторизации (например, для доступа к Lamoda B2B Platform из разных систем партнера). Чтобы создать новый токен, нужно использовать GET запрос, описанный выше.В качестве параметров client_id/client_secret можно использовать существующие значения или запросить у sales-manager новые для каждого веб-сервиса.
Каждый новый токен действителен в течение суток и не инвалидирует предыдущий.
Отправка запросов
При отправке запросов к защищенному ресурсу, в соответствии с протоколом OAuth2, в заголовке ‘Authorization’ должен передаваться токен авторизации по примеру ниже:Authorization: "Bearer NTc2NTU2NDU5ODZhZDIzYzc4ZWZmZDI4ZDI5OTNkMTMzMjdlZTA0ODRiMDY3ZmRkMzQ4YTBkMDBiM2M1MjUzMA"
Получение ключей доступа
Для ознакомления с интерфейсом Lamoda B2B Platform может быть предоставлен доступ (логин и пароль) на тестовый веб-сайт https://demo-b2b.lamoda.ru.
Для тестирования интеграции с Lamoda B2B Platform могут быть предоставлены параметры client_id\client_secret к тестовому API (https://api-demo-b2b.lamoda.ru/api/v1/).
SDK
Для ускорения интеграции с системой предоставляется SDK в свободном доступе.Логирование
При подключении и последующей работе с Lamoda B2B Platform, партнеру необходимо осуществлять логирование действий. Это позволит быстро и корректно идентифицировать возможные проблемы подключения, а также существенно сократит срок интеграции.
Логированию подлежат:
- Время запроса;
- Метод и URL запроса с query параметрами;
- Тело запроса (для POST запросов);
- Заголовки запроса;
- Тело и код ответа от Lamoda B2B Platform.
Требования к идентификаторам
При использовании API Lamoda B2B Platform важно передавать идентификаторы в запросах, например, чтобы получить данные о конкретной поставке или обновить информацию о заказе. Это позволяет системе быстро и корректно находить нужный объект среди множества других. Важно понимать, что корректное использование идентификаторов напрямую влияет на точность и надежность API-интеграций, минимизируя ошибки и конфликты данных.Требования к идентификаторам FBS, FBO
Чек-лист интеграции в test окружении
Стабилизация в Prod окружении
Стабилизация на Prod окружении FBS, FBO
Для удобства работы с документацией на платформе поддерживается актуальная API-спецификация. В ней расположены описания методов, формата и обязательности полей. Описание самих полей содержится в соответствующих разделах гида.
К спецификации можно перейти по кнопке API Specification из левого навигационного меню.
Помогла эта информация?
Спасибо за отзыв