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.