Разработчикам

Гайды по API

Как API для интеграций Saleya ведёт себя за пределами одного метода: доступ, синхронизация, повторы, конфликты, лимиты и вебхуки.

Загружаем поисковый индекс…

Гайды

Начало работы

  • Быстрый старт

    Получите токен в панели магазина и сделайте первые запросы: токен, магазин и первая страница товаров.

  • Приложения, токены и scopes

    Что может приложение, как его ограничивают scopes, как выпускать, менять и отзывать токены и как их хранить.

  • Магазин для разработки

    Проверяйте интеграцию в отдельном магазине своего аккаунта: тестовых токенов у API нет.

Работа с данными

  • Страницы и синхронизация

    Читайте списки постранично и держите копию в актуальном виде курсором синхронизации, вместе с удалёнными записями.

  • Массовые операции

    Устанавливайте остатки, записывайте товары и выгружайте заказы тысячами одним файлом NDJSON, а не запросом на запись.

  • Вебхуки

    Подпишите адрес на события магазина, проверьте подпись на PHP, Node.js или Python и обработайте повторы.

  • Бухгалтерия через API

    Загрузите учёт магазина в бухгалтерию или ERP и держите его актуальным: какой налог брать, деньги, удержания и закрытые периоды.

Надёжная интеграция

  • Ошибки

    Как выглядит отказ, что значит каждый статус и какие ошибки стоит повторять.

  • Идемпотентность

    Повторите запись после таймаута и не примените её дважды: заголовок Idempotency-Key.

  • Версии и If-Match

    Меняйте запись, не затирая то, что изменили в магазине после вашего чтения.

  • Лимиты запросов

    Сколько запросов могут слать приложение и магазин, как читать заголовки лимитов и что делать на 429.

  • Версии API

    Что может появиться в /v1 без предупреждения, что не меняется никогда и как объявляются устаревания и новые версии.