Загрузки
| Что | Ссылка | Для чего |
|---|---|---|
| Спецификация OpenAPI 3.1 | /docs/openapi.yaml | Генерация клиентов, mock-серверы, контрактные тесты |
| Коллекция Postman | /docs/postman.json | Попробовать каждый эндпоинт без написания кода |
| kyc.js (web SDK) | https://kyc.goxost.net/sdk/kyc.js |
Встраивание проверки в веб-страницу — см. Web SDK |
| Flutter SDK | kyc_flutter.zip | Приложения для Android и iOS — см. Flutter SDK |
| Плагин WordPress | goxost-kyc-wordpress.zip | WordPress и WooCommerce — см. Плагин WordPress |
Загружайте kyc.js с https://kyc.goxost.net/sdk/kyc.js при каждой загрузке страницы — не копируйте его на свой сервер, тогда вы всегда будете получать исправления.
Postman
Коллекция охватывает весь публичный API: Applicants, Sessions, Verifications, AML, Flows, Webhooks, Usage и Documents. Она строится из спецификации OpenAPI, поэтому всегда соответствует справочнику API. Direct API в коллекции нет.
- В Postman нажмите Import и вставьте ссылку
https://kyc.goxost.net/docs/postman.json(или перетащите скачанный файл). - Откройте коллекцию → Variables и задайте значения:
| Переменная | Значение |
|---|---|
baseUrl |
https://kyc.goxost.net/api/v1 (уже задано) |
api_key |
Ваш ключ sk_test_… из панели |
- Отправьте Create an applicant, затем Create a verification session и откройте
urlиз ответа в браузере, чтобы пройти проверку.
Все запросы используют Bearer-аутентификацию с {{api_key}} из коллекции. Держите api_key в колонке Current value, чтобы он не синхронизировался в общее рабочее пространство. Чтобы перейти в боевой режим, создайте окружение Postman со своим api_key = sk_live_….
Начните с тестового режима: проверки там бесплатные, имитируются и не расходуют месячный лимит. См. Тестовый и боевой режимы.
OpenAPI
openapi.yaml — первоисточник для публичного REST API (info.version: v1). У каждого эндпоинта есть operationId — те же якоря, что и в справочнике API, например createApplicant или getVerification.
Сгенерируйте типизированный клиент любым инструментом для OpenAPI 3.1, например:
curl -o openapi.yaml https://kyc.goxost.net/docs/openapi.yaml
npx @openapitools/openapi-generator-cli generate -i openapi.yaml -g typescript-fetch -o ./kyc-client
Код проверки подписи и Direct API описаны в главах Вебхуки и Direct API.
Версии и изменения
- Версия API — часть пути:
/api/v1. В рамкахv1изменения только добавляются — могут появиться новые эндпоинты, необязательные поля запроса, поля ответа, типы событий, коды причин отказа и коды ошибок; существующие не переименовываются и не удаляются. - Игнорируйте незнакомые поля и аккуратно обрабатывайте неизвестные значения — например, считайте неизвестный код причины отказа как
ON_HOLD. Несовместимое изменение выйдет как новая версия (/api/v2). См. Версионирование. - Коллекция Postman пересобирается из спецификации при каждом скачивании, поэтому импортируйте её заново (или скачайте
openapi.yamlснова), чтобы получить новые эндпоинты и поля.