Довідник API
API v1Ендпоінти, автентифікація та відповіді.
Основи
- ОглядБазова адреса, форма запиту й відповіді та домовленості, яких дотримується кожна операція API.4 хв
- АвтентифікаціяЯк запит повідомляє, хто він, — API-ключ, єдиний проєкт, у якому ключ діє, і дозволи, що кажуть, що йому можна.3 хв
- ЗапитиЯкі заголовки надсилає запит і несе відповідь, як довгий список читається сторінками і скільки запитів може надіслати ключ.3 хв
- ІдемпотентністьЗаголовок Idempotency-Key — яким запитам він потрібен, чим відповідають на повторний запит і як вибрати ключ.3 хв
- Коди помилокКонверт помилки, звідки береться її код, і кожен код, яким відповідає API, — що він означає і що з ним робити.4 хв
- ВебхукиЩо несе доставка вебхука, як перевірити її підпис, коли її надсилають знову і про що повідомляє кожна родина подій.6 хв
- Специфікація OpenAPIЩо містить документ OpenAPI для Slen API, як із нього зібрано сторінки цього розділу і як читати сторінку операції.2 хв
Ресурси
- ОпераціїНадішліть запит через флоу, прив’язаний до коду операції, прочитайте операції — виклики моделі у флоу — з усіма спробами за ними й отримайте список холдів цих викликів.
- ВиконанняЧитайте статус виконання, поки воно йде, і його трасування по вузлах, коли воно просунулося.
- Клієнти та кредитиДодавайте своїх клієнтів, ведіть їхні рахунки кредитів, поповнюйте, списуйте й коригуйте їхні кредити, блокуйте клієнта й задавайте, скільки кредитів коштує операція.
- ПогодженняОтримайте список запитів на погодження, на які чекають виконання, і схваліть або відхиліть запит.
- МоделіПрочитайте, які моделі може назвати запит і за якою ціною кожна з них рахується зараз.
- ФлоуСтворіть флоу, збережіть його чернетку, перевірте й опублікуйте його, відкотіть його, дайте йому код операції і читайте його виконання та аналітику.
- БюджетиОтримайте список бюджетів із тим, що від них лишилося, створіть бюджет, змініть його ліміт, надішліть його в архів або відновіть.
- СповіщенняПрочитайте стрічку сповіщень, які відкрилися в проєкті, і позначте сповіщення як переглянуте.
- АналітикаПрочитайте, скільки витратив проєкт, чим закінчилися його виконання, наскільки точними були оцінки його викликів моделі та скільки коштували його клієнти.
- Записи реєструПрочитайте журнал грошей, які проєкт зарезервував, повернув і витратив, запис за записом.
- Підключення провайдерівЗбережіть API-ключ провайдера моделей, перевірте, що він працює, задайте його ліміти й на якийсь час виведіть його з роботи.
- Пули провайдерівСтворіть пул підключень провайдерів, розставте його учасників, прочитайте їхній поточний запас і те, як пул обслуговував виклики.
- Перевірки стануДві перевірки стану, яким не потрібен ключ, кажуть, чи відповідає API і чи відповідають його залежності, а одна операція — що відбувається, поки реєстр недоступний.