Тестовий ключ працює в пісочниці. Ваші запити проходять через той самий шлюз, що й з робочим ключем: ключ, області доступу, ліміти, Idempotency-Key, перевірка запиту, завдання, файли та вебхуки працюють як у бою. Імітується лише сама робота: жоден інструмент не запускається, нічого не створюється й нічого не списується.
Отримати тестовий ключ
У кабінеті відкрийте API → Ключі, оберіть тип ключа Тестовий і створіть ключ. Тестовий ключ починається з gsk_test. Користуйтеся ним так само, як робочим.
Кожна відповідь пісочниці містить заголовок Grem-Sandbox: true, тож тестовий журнал не сплутати з реальною роботою, - включно з відповідями, даними до перевірки ключа (зіпсований JSON, 413, невідомий шлях).
Що відбувається
- Перевірка запиту справжня. Запит, який відхилив би бій, пісочниця відхиляє з тим самим статусом і причиною: бракує поля, менше 4 фото в пакеті контенту, тексти без об'єкта, опису, міста і площі. Перевіряються й поля форми в запитах
multipart, поля звіту чужої категорії, значенняheatingTypeбудинку, а також завантажені файли: тип і розмір. Що бій обрізає або замінює (довгий текст, невідомуlengthвідео), пісочниця теж приймає. - Результати є зразками. Синхронні інструменти одразу відповідають фіксованими зразками. Асинхронні повертають
jobId; завдання проходитьpending→running→ результат приблизно за 5 секунд. - Перевірка звіту зупиняється в
action_requiredзі зразковими данимиextracted, як у бою; підтвердіть її черезPOST /valuation/review/jobs/{id}/confirm. - Файли є заглушками. PDF і зображення справжні, їх можна відкрити; відео, docx і тексти - короткі підписані заглушки з правильним типом вмісту. Файл є лише в завершеного завдання пісочниці, за шляхом його інструмента і з id артефакту, який повернуло завдання, - інакше
404. Відео аватара віддається за будь-яким id артефакту завершеного завдання, як у бою.Rangeпрацює (206,416). - Вебхуки справжні. Тестовий ключ створює і змінює лише адреси вебхуків пісочниці. Вони отримують лише події завдань пісочниці - підписані доставки з повторами, точно як у бою. Бойові адреси події пісочниці не отримують ніколи, а тестовий ключ їх не бачить і не змінює.
Обрати результат
Заголовок Grem-Simulate визначає, чим завершиться виклик або завдання:
| Значення | Результат |
|---|---|
completed | за замовчуванням: завдання завершується успішно |
failed | завдання завершується failed; синхронний інструмент відповідає 502 provider_error |
partial | пакет контенту завершується partial; інші інструменти - успішно |
insufficient_funds | 402 з code: INSUFFICIENT_FUNDS |
service_unavailable | інструмент недоступний: саме та відповідь, що в роботі для інструмента, який GET /tools/status показує недоступним, - 503, Retry-After: 60, нічого не створюється (content/generate, text/generate, video/create, avatar/video, site/create, floorplan/create, photo/enhance, valuation/express); інші інструменти - 503 з Retry-After: 30 |
provider_error | 502 provider_error |
Регістр значення не важливий. Невідоме значення дає 400, тож описка ніколи не пройде як успіх. Робочі ключі заголовок ігнорують.
curl -X POST https://developers.grem.capital/api/v1/text/generate \
-H "Authorization: Bearer gsk_test_xxx" \
-H "Content-Type: application/json" \
-H "Grem-Simulate: failed" \
-d '{"city":"Berlin","totalArea":64}'
Що може тестовий ключ
| Запит | З тестовим ключем |
|---|---|
Інструменти, POST /valuation/express, підтвердження перевірки звіту | імітуються |
| Керування вебхуками | лише адреси пісочниці |
Читання (GET): об'єкти, ліди, словники, голоси тощо | реальні дані вашого акаунта |
| Створення й зміна об'єктів, лідів, подій Swipe Match, завантаження, чат | відхиляються: 403 forbidden |
Відмінності від бою
- Результати - фіксовані зразки, а не оцінка чи справжні тексти. Не показуйте їх своїм користувачам.
- Пісочниця не перевіряє, що об'єкт у
objectIdіснує і належить вам; бій у такому разі відповідає403або404. - Завдання та результати зберігаються добу.