Обліковий запис
- GET /v1/account - перевірка авторизації, рівень перегляду
- GET /v1/account/usage - використання за поточний період
- PUT /v1/account/webhook - встановити URL-адресу веб-хука + події
РОЗРОБНИКИ - КОЛЕКЦІЯ ЛИСТОНОШ
Імпортуйте колекцію. За п'ять хвилин - API.
Готова колекція Postman з робочими прикладами для кожної кінцевої точки Fabrixa REST. Введіть свій ключ API, перегляньте запити, подивіться реальні відповіді в пісочниці пісочниці, перш ніж написати хоч один рядок інтеграційного коду. Відстежується за версіями версії - колекція оновлюється разом з API.
POSTMAN v10+ - SANDBOX + PRODUCTION ENVS - ОНОВЛЮЄТЬСЯ КОЖЕН ВИПУСК API
ЩО Є В КОЛЕКЦІЇ
Кожна кінцева точка з прикладами корисного навантаження.
Організовано в папки за ресурсами: Обліковий запис, Продукти, Замовлення, Веб-хуки, Редактор SDK. Кожен запит містить відпрацьований приклад тіла, попередньо встановлені заголовки і приклад збережена успішна відповідь - щоб ви могли переглянути форму відповіді перед відправленням.
Продукти
- GET /v1/products - перелічити / розбити на сторінки / відфільтрувати
- GET /v1/products/:id - повна інформація про продукт
- GET /v1/products/:id/pricing - попередній перегляд рівня обсягу
Накази
- НАДІСЛАТИ /v1/orders - створити (з ключем idempotency)
- GET /v1/orders - список / пагінація
- GET /v1/orders/:id - статус, відстеження, життєвий цикл
- DEL /v1/orders/:id - скасувати до блокування виробництва
Веб-хуки та SDK
- НАДІСЛАТИ /v1/webhooks/test - запуск події вибірки
- GET /v1/webhooks/events - перелік типів подій
- GET /v1/sdk/keys - відкриті + секретні ключі SDK
ІМПОРТ ЗА 30 СЕКУНД
Postman → Файл → Імпорт → Посилання → вставити URL-адресу.
01
ІМПОРТУВАТИ КОЛЕКЦІЮ
У "Листоноші": Файл → Імпорт → Посилання. Вставте URL-адресу JSON з кнопки завантаження вище. Postman отримає і додасть колекцію до вашої робочої області.
02
ІМПОРТУВАТИ СЕРЕДОВИЩЕ
Той самий потік, URL-адреса середовища: .../fabrixa-api.postman_environment.json. Встановлює змінну scaffolding (базовий URL, заповнювач ключа API).
03
ВСТАНОВІТЬ СВІЙ КЛЮЧ API
Відкрийте імпортоване середовище, заповніть FABRIXA_API_KEY за допомогою ключа від пісочниці. Перейдіть до виробничого середовища, коли будете готові до відправки.
ЗМІННІ СЕРЕДОВИЩА
Що знаходиться у файлі env.
fabrixa.postman_environment.json
# Середовище пісочниці { "FABRIXA_BASE_URL": "https://sandbox.api.fabrixa.com/v1", "FABRIXA_API_KEY": "sk_sandbox_yourKeyHere", "FABRIXA_PUBLIC_KEY": "pk_sandbox_yourPublicKey", "FABRIXA_WEBHOOK_URL": "https://your-tunnel.ngrok.io/webhook" } # Виробниче середовище (окремий файл) { "FABRIXA_BASE_URL": "https://api.fabrixa.com/v1", "FABRIXA_API_KEY": "sk_live_yourKeyHere", "FABRIXA_PUBLIC_KEY": "pk_live_yourPublicKey", "FABRIXA_WEBHOOK_URL": "https://api.yourbrand.com/webhook" }
AUTH PRE-CONFIGURED
Токен на пред'явника наноситься на рівні інкасації.
Колекція Авторизація налаштовано на успадкування ключа API від активного середовища. Кожен запит всередині колекції підхоплює його автоматично - немає необхідності налаштовувати заголовок для кожного запиту.
Перехід від пісочниці до виробництва здійснюється одним кліком у випадаючому списку середовища. Та сама колекція, інші ключі, інша базова URL-адреса. Ніяких змін у коді не потрібно.
РОБОЧІ ПРИКЛАДИ
Кожен запит надсилається зі зразком тіла та збереженою відповіддю.
Колекція - це не просто заглушки URL-адрес, кожен запит супроводжується відпрацьованим щоб ви могли натиснути кнопку "Відправити" і побачити реальні дані. Збережені приклади відповідей відображаються на панелі Приклади для перегляду в автономному режимі.
СТВОРИТИ ЗАМОВЛЕННЯ
POST /v1/замовлення
Приклад тіла листа для замовлення 2-х футболок з власною URL-адресою ілюстрації, адресою одержувача та ключем idempotency. Натисніть кнопку Надіслати, щоб побачити відповідь 201 Створено з order_id.
ПЕРЕЛІК ПРОДУКТІВ
GET /v1/products
Попередньо відфільтрований запит для категорії одягу. Повертає посторінковий каталог з розмірами, GSM, термінами виконання та рівнем цін для SKU.
ТРИГЕРНИЙ ВЕБХУК
POST /v1/webhooks/test
Вручну запустіть зразок події вебхука на вашу зареєстровану URL-адресу. Корисно для налагодження обробників вебхуків без розміщення реального замовлення.
ПЕРЕВІРТЕ ВИКОРИСТАННЯ
GET /v1/account/usage
Поточне використання за розрахунковий період, статус прогресії рівнів, прогнозований обсяг на кінець періоду. Корисно для планування потужностей перед великим падінням.
СКАСУВАТИ ЗАМОВЛЕННЯ
ВИДАЛИТИ /v1/orders/:id
Скасувати замовлення до того, як воно заблокує виробництво (зазвичай протягом 24 годин з моменту розміщення). Повертає 409, якщо виробництво вже розпочато - ключ idempotency обробляє повторні спроби.
ПОПЕРЕДНІЙ ПЕРЕГЛЯД ЦІН
GET /v1/products/:id/pricing
Попередній перегляд ціни за одиницю товару на всіх рівнях обсягу для певного SKU. Корисно для демонстрації клієнтам економії на одиниці продукції при масштабуванні обсягу замовлення.
ВЕРСІОНАЛІЗАЦІЯ
Колекція оновлюється разом з API.
Кожен випуск Fabrixa API містить оновлену колекцію Postman за тією самою URL-адресою. Повторний імпорт для отримання нових кінцевих точок і прикладів корисного навантаження - наявні запити у вашій збереженій версії працюватимуть доти, доки ця кінцева точка не стане застарілою.
01
СТАБІЛЬНА URL-АДРЕСА
JSON-адреса колекції є постійною. Повторний імпорт витягує останню версію. URL-адреса ніколи не змінюється між випусками API.
02
ПОСИЛАННЯ НА ЖУРНАЛ ЗМІН
Дивіться. Журнал змін для відповідних версій API - що було змінено, що додано, що застаріло.
03
АМОРТИЗАЦІЙНА ПОЛІТИКА
Кінцеві точки отримують 12-місячне вікно застарівання. Колекція позначає застарілі запити в описі, тому їх важко пропустити до того, як вони вийдуть з ладу.
ЗАВАНТАЖИТИ ТА ЗАПУСТИТИ
Забирай колекцію. Запускай свій перший запит.
Імпорт URL-адреси: https://www.fabrixa.com/wp-content/themes/brighthub-fabrixa/assets/downloads/fabrixa-api.postman_collection.json