Yuklamalar
| Nima | Havola | Nima uchun |
|---|---|---|
| OpenAPI 3.1 spetsifikatsiyasi | /docs/openapi.yaml | Klient, mock server va kontrakt testlarini yaratish |
| Postman toʻplami | /docs/postman.json | Har bir endpointni kod yozmasdan sinab koʻrish |
| kyc.js (web SDK) | https://kyc.goxost.net/sdk/kyc.js |
Jarayonni veb-sahifaga joylash — Web SDK bobiga qarang |
| Flutter SDK | kyc_flutter.zip | Android va iOS ilovalari — Flutter SDK bobiga qarang |
| WordPress plagini | goxost-kyc-wordpress.zip | WordPress va WooCommerce — WordPress plagini bobiga qarang |
kyc.js ni har safar sahifa yuklanganda https://kyc.goxost.net/sdk/kyc.js dan yuklang — uni serveringizga koʻchirmang, shunda tuzatishlar sizga doim yetib keladi.
Postman
Toʻplam butun ochiq API ni qamrab oladi: Applicants, Sessions, Verifications, AML, Flows, Webhooks, Usage va Documents. U OpenAPI spetsifikatsiyasidan yaratiladi, shuning uchun doim API maʼlumotnomasiga mos keladi. Direct API toʻplamga kirmaydi.
- Postman da Import ni bosing va
https://kyc.goxost.net/docs/postman.jsonhavolasini qoʻying (yoki yuklab olingan faylni tashlang). - Toʻplamni oching → Variables va qiymatlarni kiriting:
| Oʻzgaruvchi | Qiymat |
|---|---|
baseUrl |
https://kyc.goxost.net/api/v1 (allaqachon kiritilgan) |
api_key |
Paneldagi sk_test_… kalitingiz |
- Create an applicant ni, keyin Create a verification session ni yuboring va jarayondan oʻtish uchun javobdagi
urlni brauzerda oching.
Barcha soʻrovlar toʻplamdagi {{api_key}} bilan Bearer autentifikatsiyasidan foydalanadi. api_key ni Current value ustunida saqlang, shunda u umumiy ish maydoniga sinxronlanmaydi. Ishchi rejimga oʻtish uchun api_key = sk_live_… boʻlgan alohida Postman muhitini yarating.
Sinov rejimidan boshlang: u yerdagi tekshiruvlar bepul, simulyatsiya qilinadi va oylik limitingizni sarflamaydi. Sinov va ishchi rejim bobiga qarang.
OpenAPI
openapi.yaml — ochiq REST API ning asosiy manbasi (info.version: v1). Har bir endpointda operationId bor — bu API maʼlumotnomasidagi anchorlarning oʻzi, masalan createApplicant yoki getVerification.
Istalgan OpenAPI 3.1 vositasi bilan tiplangan klient yarating, masalan:
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
Imzoni tekshirish kodi va Direct API uchun Webhooklar va Direct API boblaridan foydalaning.
Versiyalar va oʻzgarishlar
- API versiyasi yoʻlning bir qismi:
/api/v1.v1ichida faqat qoʻshimchalar boʻladi — yangi endpointlar, ixtiyoriy soʻrov maydonlari, javob maydonlari, hodisa turlari, rad etish belgilari va xato kodlari qoʻshilishi mumkin; mavjudlari qayta nomlanmaydi va olib tashlanmaydi. - Bilmagan maydonlaringizga eʼtibor bermang va nomaʼlum qiymatlarni ehtiyotkorlik bilan qayta ishlang — masalan, nomaʼlum rad etish belgisini
ON_HOLDkabi qabul qiling. Buzuvchi oʻzgarish yangi versiya (/api/v2) sifatida chiqadi. Versiyalash boʻlimiga qarang. - Postman toʻplami har bir yuklab olishda spetsifikatsiyadan qayta yaratiladi, shuning uchun yangi endpoint va maydonlarni olish uchun uni qayta import qiling (yoki
openapi.yamlni qayta yuklab oling).