Подключите свои инструменты к заказам, доступным остаткам и отслеживанию отправлений через REST API, TypeScript SDK и вебхуки.
Откройте портал разработчика, чтобы посмотреть доступные вашему аккаунту API и SDK для вашей среды. Необходимо войти в аккаунт и иметь соответствующие права доступа.
SDK для TypeScript
Серверный пример на TypeScript с использованием клиента бизнес-функций Ysend. Укажите базовый адрес API, согласованный при подключении, и храните ключ API в переменных окружения на сервере.
import { Ysend } from "@ysend/sdk";
const ysend = new Ysend({
baseUrl: process.env.YSEND_API_BASE_URL!,
apiKey: process.env.YSEND_API_KEY!,
});
const stock = await ysend.inventory.listBalances({ page: 1, pageSize: 20 });
const orders = await ysend.orders.list({ status: "Open", page: 1, pageSize: 20 });
const shipments = await ysend.shipments.list({ page: 1, pageSize: 20 });Для примера нужны права inventory:read, orders:read и shipments:read. Для операций записи через SDK передавайте постоянный Idempotency-Key, чтобы повторная попытка не создавала вторую операцию.
Используйте Node.js 20 или новее. Если портал предлагает SDK, запишите его версию и имя файла, затем проверьте SHA-256 скачанного файла. Замените PACKAGE_FILE.tgz ниже точным именем этого файла.
npm install ./PACKAGE_FILE.tgzYSEND_API_BASE_URL должен содержать согласованный адрес API: протокол HTTPS и имя хоста, без /api/v1. SDK добавляет этот путь самостоятельно. Храните YSEND_API_KEY на сервере; запросы используют X-Api-Key.
Каждый запрос списка возвращает одну страницу. Укажите page и pageSize, затем проверьте items, totalCount, page и pageSize, если они переданы в ответе, прежде чем запрашивать продолжение. Первая страница не является полным экспортом.
YsendError предоставляет доступные статус HTTP, detail и traceId. YsendTransportError означает, что пригодный для обработки ответ не получен; результат операции записи при этом может быть неизвестен.
По умолчанию выполняются три попытки всего с ожиданием заголовков ответа до 30 секунд при каждой попытке. GET/HEAD и запросы с Idempotency-Key могут повторяться после сетевой ошибки или HTTP 429, 502, 503 либо 504. Используйте один и тот же ключ для одной операции. orders.list использует POST без этого ключа и не получает таких автоматических повторов.
В обращении по интеграции опишите ваши инструменты и данные для обмена. Наша команда поможет определить подходящую документацию API, SDK и права доступа для вашей организации. Не передавайте секретные данные.
Начало работы
После активации аккаунта уполномоченный администратор создаёт ключ с правами, необходимыми вашей интеграции.
Если для вашей среды опубликован пакет SDK, скачайте его с портала разработчика, проверьте SHA-256 и установите скачанный файл.
Читайте остатки, заказы и отправления в соответствии с правами, назначенными вашему ключу.
Вебхуки
Создавайте подписки в веб-приложении, проверяйте их с помощью ping и просматривайте попытки доставки. Очередь исходящих сообщений повторяет отправку после сбоев, допускающих повтор; события, исчерпавшие попытки, остаются видны в очереди недоставленных сообщений.
Возможности
Импортируйте CSV или структурированные строки; проверяйте, исправляйте и повторно отправляйте отклонённые строки.
Сопоставляйте SKU и читайте фактические, зарезервированные и доступные остатки.
Готовьте планы поставок, добавляйте строки, запрашивайте интервалы доставки и отслеживайте расхождения при приёмке.
Читайте сведения о перевозчике, отслеживании и статусе доставки после создания отправления в процессе исполнения заказа.
Откройте обращение по заказу и приложите фотографии или документы.
Читайте подписки и историю доставки из вашей интеграции.
Ключи партнёров
Храните ключи на своём сервере. Права аккаунта и партнёра определяют каждую операцию; созданием и ротацией ключей, а также настройкой вебхуков управляют уполномоченные администраторы в соответствующем портале.
Подготовьте описание потока данных и необходимых операций. Мы подтвердим доступ к аккаунту, права и пакет SDK для вашей интеграции.
Команда Ysend поможет выбрать услуги, подключения и план внедрения для вашего бизнеса.