SDK для Node.js и Python
Как подключить официальный SDK Yario, безопасно выполнять запросы и проверять уведомления.
Официальные SDK снимают с команды партнёра повторяющуюся работу: добавляют ключ в серверные запросы, создают ключи идемпотентности, безопасно повторяют временно неудачные запросы, приводят ошибки API к единому виду и проверяют подписи уведомлений.
SDK не заменяет договор, тестовый доступ или техническую проверку. Он реализует транспортный слой поверх того же Integration API.
Node.js
Установите пакет:
npm install https://github.com/yario-ai/yario-integration-sdks/releases/download/v0.1.0/yario-ai-integration-sdk-0.1.0.tgz
Создайте клиент только на сервере:
import { YarioClient } from "@yario-ai/integration-sdk";
const yario = new YarioClient({
apiKey: process.env.YARIO_API_KEY,
baseUrl: "https://integration-api.yario.ai"
});
const profile = await yario.getProfile();
const installations = await yario.listInstallations();
Python
Установите пакет:
pip install https://github.com/yario-ai/yario-integration-sdks/releases/download/v0.1.0/yario_integration-0.1.0-py3-none-any.whl
Создайте клиент в серверном приложении:
import os
from yario_integration import YarioClient
with YarioClient(
api_key=os.environ["YARIO_API_KEY"],
base_url="https://integration-api.yario.ai",
) as yario:
profile = yario.get_profile()
installations = yario.list_installations()
Что остаётся на стороне партнёра
- хранить ключ и секрет уведомлений в защищённом хранилище;
- проверять, что подключение и клиент разрешены для выбранного сценария;
- хранить обработанные идентификаторы уведомлений в общей базе или кеше;
- записывать бизнес-результат операции, а не API-ключ или персональные данные;
- пройти тестирование и техническую проверку.
При проверке уведомления передавайте SDK исходные байты HTTP-запроса до разбора JSON. Для защиты от повторов передайте функцию claim, которая атомарно сохраняет идентификатор события и возвращает false, если он уже был обработан.
Исходный код обоих SDK, примеры и сценарии проверки находятся в публичном репозитории yario-integration-sdks. Готовые пакеты опубликованы в GitHub Releases; npm и PyPI будут добавлены как дополнительные каналы после регистрации аккаунтов владельца. Полное приложение на Node.js можно посмотреть в готовом примере платёжной интеграции или открыть как работающее демо.
Навигация: начало работы · обзор API · доступ и безопасность · уведомления · тестирование