Доступ до API та автентифікація

SPREEAI надає публічний довідник API для затверджених робочих процесів партнерів: https://docs.spreeai.com/swagger/public/.

Модель доступу

Область дії API, середовище, облікові дані та дозволені операції узгоджуються під час реєстрації партнерів. Не припускайте, що внутрішня, розробницька або історична кінцева точка доступна у виробництві.

Правила облікових даних

Зберігайте секретні дані клієнта та токени доступу лише в безпечному сховищі секретних даних на стороні сервера.
Ніколи не передавайте облікові дані до Git, документації, систем відстеження проблем, скріншотів або зразків програм.
Ніколи не надсилайте облікові дані на платформи аналітики або реєстрації.
Використовуйте облікові дані, що стосуються певного середовища, лише з тим середовищем, для якого вони були видані.
Негайно поверніть облікові дані, якщо вони викриті.
Видаліть заголовки та токени авторизації із запитів на підтримку.

Браузер проти сервера

Веб-SDK використовує конфігурацію браузера, видану партнером. Секрет клієнта не повинен бути включений до браузера.

Інтеграції на стороні сервера повинні відповідати процесу автентифікації та визначенню кінцевих точок у поточному затвердженому довіднику API. Якщо потрібна операція відсутня, запитуйте її через відділ партнерської інженерії, а не створюючи недокументований маршрут.

Вебхуки

Вебхуки, що надсилаються сервером, не є частиною опублікованої документації Web SDK. Підтвердьте будь-які вимоги до вебхука, перш ніж розробляти залежність від нього.

Контрольний список для екологічних питань

[ ] Назва середовища задокументована.
[ ] Базова URL-адреса взята із затвердженого посилання або передачі даних для реєстрації.
[ ] Для цього середовища було видано повномочності.
[ ] Секрети зберігаються на стороні сервера.
[ ] Реєструє видалення токенів та зображень клієнтів.
[ ] Для операцій запису узгоджено тайм-аути, повторні спроби та поведінку ідемпотентності.
[ ] Невиробниче тестування успішно завершено до використання виробничого доступу.