SDK

v0.3.2

Добавьте контроль расходов в своё приложение.

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

  • Обзор
    Что ваше приложение делает через SDK — запускает флоу, ждёт их, ведёт клиентов и их кредиты, проверяет вебхуки, — и что SDK делает сам при каждом вызове.
    3 мин
  • Установка
    Что нужно каждому SDK, как установить его пакет, как обратиться к Slen без него и с каким API-ключом он работает.
    3 мин
  • Быстрый старт
    Запустите опубликованный флоу из своего приложения через SDK и прочитайте, что он ответил.
    6 мин
  • Конфигурация
    С какими опциями собирается SDK, для чего каждая из них и какую единственную переменную окружения он читает.
    3 мин
  • Интеграция с Laravel
    Сервис-провайдер, фасад Slen и файл конфигурации PHP SDK — что приложение на Laravel получает от пакета и что задаёт в своём окружении.
    5 мин

Запросы

  • Отправить запрос
    Запустите флоу с его входом, клиентом, для которого он выполняется, и контекстом вызова и прочитайте каждое поле выполнения, которое вернётся.
    6 мин
  • Асинхронные запуски и ожидание
    Отправьте запуск, не дожидаясь его, дождитесь выполнения, которое ответило queued или waiting, и прочитайте его статус и трассировку.
    6 мин
  • Ключи идемпотентности
    Дайте запуску или движению кредитов ключ, который называет его единицу работы, — тогда на повтор, от SDK, от вашей очереди или от вашего кода, ответят, а не сделают работу заново.
    5 мин

Клиенты

  • Клиенты и кредиты
    Создайте клиента, пополните и спишите его кредиты, прочитайте баланс и выписку, запустите флоу, который оплачивает клиент, и заблокируйте клиента.
    7 мин
  • Когда трата отклонена
    Ошибки, которые говорят, что бюджет, лимит или кредиты клиента отклонили запуск, две формы такого отказа и что делать с каждой.
    3 мин

Вебхуки

  • Вебхуки
    Проверьте подпись доставки, прочитайте её как типизированное событие, ответьте Slen и отличите доставку от её повтора.
    5 мин

Ошибки и повторы

  • Обработка ошибок
    Что несёт ошибка SDK, как ловить её по типу и ветвиться по коду и какие ошибки говорят, что запуск мог стоить денег.
    5 мин
  • Повторы и таймауты
    Какие запросы SDK повторяет сам и после какой паузы, какие ответы он не повторяет никогда и что ограничивает каждый таймаут SDK.
    4 мин
  • Когда исход неизвестен
    Как SDK сообщает, что провайдер был вызван, а его ответ потерян, что Slen делает с деньгами и как повторить запуск, не заплатив дважды.
    3 мин

Справочник

  • Клиент и методы
    Точка входа каждого SDK, его модули и каждый вызов, который они предлагают, — с запросом API, который делает вызов, разрешением, которое ему нужно, и ключом идемпотентности, который он несёт.
  • Объекты ответа
    Объекты, которые возвращают вызовы SDK, — выполнение, его трассировка, клиент, счёт, строка выписки, страница — и какое поле ответа API несёт каждое их поле.
  • Типы ошибок
    Тип ошибки, который каждый SDK выбрасывает для кода ошибки API, как типы связаны между собой и какие ошибки SDK выбрасывают сами.
  • Журнал
    Дайте SDK логгер и прочитайте события, которые он пишет на каждый запрос, — маршрут, статус и время, но никогда ключ или тело.
    5 мин
  • Спаны
    Спан, который SDK пишет на каждый запуск и каждое ожидание, — его поля, куда он уходит и как попадает в ваши логи или трассировки.
    6 мин
  • Тестирование интеграции
    Используйте тестовый дублёр, который поставляется с SDK, чтобы ставить в очередь ответы API и проверять запросы, которые отправил ваш код.
    4 мин
  • PHP и Node.js
    Каждый вызов двух SDK рядом и чем ещё они различаются — среда выполнения, HTTP-клиент, журнал, спаны, Laravel.