Asosiy qismga oʻtish
API hujjati API kalitini olish

SDK va plaginlar · 12-bob

WordPress plagini

WordPress yoki WooCommerce saytiga shaxsni tasdiqlashni kod yozmasdan qoʻshing. Plagin jarayonni sahifaga joylaydi, qarorlarni webhook orqali oladi va mijoz tasdiqlanmaguncha buyurtma berishni toʻsib qoʻya oladi.

4 daqiqa oʻqish

Oʻrnatish

Talablar: WordPress 6.0+, PHP 7.4+. WooCommerce ixtiyoriy.

  1. goxost-kyc-wordpress.zip ni yuklab oling.
  2. WordPress da Plugins → Add New → Upload Plugin ni oching, zip faylni tanlang va Install Now ni, keyin Activate ni bosing.
  3. Settings → GOXOST KYC ni oching.

Hisobingizni ulash

Sizga GOXOST KYC panelidan API kaliti va webhook manzili kerak (roʻyxatdan oʻting yoki kiring).

  1. Panelda API kaliti yarating (Autentifikatsiya bobiga qarang). sk_test_… kalitdan boshlang.
  2. Plagin sozlamalarida uni API maxfiy kaliti (API secret key) maydoniga qoʻying. Sozlamalar sahifasi rejimni koʻrsatadi: sk_test_… uchun Sandbox, sk_live_… uchun Live.
  3. Sozlamalar sahifasida koʻrsatilgan webhook manzilini nusxalang:
https://your-site.example/wp-json/goxost-kyc/v1/webhook
  1. Panelda Webhooklar → Manzil qoʻshish ni oching, manzilni qoʻying va hodisalarni tanlang. Tavsiya etiladi: verification.completed, verification.on_hold, verification.reviewed, session.started, verification.submitted, applicant.reset, applicant.deleted, applicant.reverification_due (yoki shunchaki Barcha hodisalar — plagin qolganlariga eʼtibor bermaydi). «Natija tayyor» hodisasiga hujjat maʼlumotini qoʻshish ni oʻchiq qoldiring.
  2. whsec_… sirini (u bir marta koʻrsatiladi) Webhook imzo siri (Webhook signing secret) maydoniga nusxalang.
  3. Saqlang, soʻng Ulanishni tekshirish (Test connection) ni bosing. Tarifingiz va davr bilan «Ulandi» yozuvi chiqishi kerak.

API kaliti va webhook bitta muhitga tegishli boʻlishi kerak: sk_test_… kalit bilan sinov manzilidan, sk_live_… kalit bilan ishchi manzilidan foydalaning. Boshqa muhitdan kelgan hodisalarga eʼtibor berilmaydi.

Sozlamalar

Sozlama Tavsif
API maxfiy kaliti (API secret key) sk_test_… yoki sk_live_…. WordPress da saqlanadi, brauzerga hech qachon yuborilmaydi
Asosiy URL (Base URL) https://kyc.goxost.net — faqat Yordam markazi aytsa oʻzgartiring
Webhook imzo siri (Webhook signing secret) Webhook manzilingizning whsec_… siri
Senariy (flow) kaliti (Flow key) Ixtiyoriy. Boʻsh boʻlsa, hisobingizning standart senariysi ishlatiladi. Senariy foydalanuvchining arizachisi birinchi marta yaratilganda belgilanadi
Til (Language) Avtomatik (sayt tili), oʻzbekcha, ruscha yoki inglizcha
Tekshiruv sahifasi (Verification page) Shortcode yoki blok joylangan sahifa. Havolalar uchun ishlatiladi, masalan buyurtma sahifasidagi ogohlantirishda
WooCommerce Buyurtma berishdan oldin tekshiruvni talab qilish (Require verification before checkout)
Oʻchirish (Uninstall) Plagin oʻchirilganda maʼlumotlarni ham oʻchirish (Delete data on uninstall) — foydalanuvchilar uchun saqlangan tekshiruv holati va ID larni oʻchiradi

Tekshiruv sahifasini qoʻshish

Sahifa yarating va unga GOXOST KYC tekshiruvi (GOXOST KYC verification) blokini (goxost-kyc/verification) yoki shortcode ni qoʻshing:

[goxost_kyc]

Ixtiyoriy atributlar shu sahifa uchun plagin sozlamalarini almashtiradi:

[goxost_kyc flow="basic-kyc" locale="ru"]
Atribut Qiymatlar
flow Paneldagi senariy kaliti
locale uz, ru, en

Tashrif buyuruvchi nimani koʻradi:

  • Tizimga kirmagan — xabar va Kirish (Log in) tugmasi. Tekshiruv WordPress hisobiga bogʻlangan.
  • Tasdiqlanmagan, jarayonda yoki rad etilgan — joriy holat va Shaxsimni tasdiqlash (Verify my identity) yoki Qayta urinish (Try again) tugmasi. Jarayon shu sahifaning oʻzida ochiladi.
  • Jarayondan keyin — «Rahmat! Natijangiz tekshirilmoqda…», soʻng holat serverdan yangilanadi.
  • Koʻrib chiqilmoqda yoki tasdiqlangan — faqat holat.

Har bir WordPress foydalanuvchisiga external_id si wp_<user ID> boʻlgan bitta arizachi yaratiladi, masalan wp_42. Ularni panelda shu id boʻyicha topishingiz mumkin.

WooCommerce buyurtmasi

Buyurtma berishdan oldin tekshiruvni talab qilish (Require verification before checkout) yoqilgan boʻlsa, GREEN boʻlmagan mijoz buyurtma sahifasida tekshiruv sahifasiga havolasi bor ogohlantirishni koʻradi va buyurtma bera olmaydi. Bu klassik buyurtma sahifasida ham, buyurtma blokida ham ishlaydi. Mehmonlardan avval tizimga kirish soʻraladi.

Holat qayerda saqlanadi

Plagin user meta da faqat ID lar, qaror va vaqtni saqlaydi — hech qachon ism, hujjat maʼlumoti yoki rasmlarni emas.

Meta kaliti Qiymati
goxost_kyc_status GREEN, RED, ON_HOLD yoki pending; foydalanuvchi hech boshlamagan boʻlsa boʻsh
goxost_kyc_applicant_id apl_…
goxost_kyc_verification_id Oxirgi qarorning ver_… si
goxost_kyc_decided_at Qaror vaqti, ISO 8601 UTC

Holat faqat imzolangan webhook yoki API dan oʻqish orqali oʻzgaradi: applicant.reset va GREEN muddatining tugashi qarorni tozalaydi, applicant.deleted hammasini oʻchiradi.

Users boʻlimidagi KYC ustuni har bir foydalanuvchining holatini koʻrsatadi. Foydalanuvchi profilida Shaxsni tasdiqlash (GOXOST KYC) boʻlimi bor; administratorlar ID larni va API dan yangilash (Refresh from API) tugmasini ham koʻradi.

Dasturchilar uchun hooklar

Holatni shablonlarda yoki oʻz kodingizda tekshiring:

if ( goxost_kyc_is_verified() ) {          // current user
    // show verified content
}

if ( goxost_kyc_is_verified( $user_id ) ) { // any user
    // ...
}

goxost_kyc_is_verified( $user_id = null ) saqlangan holatni oʻqiydi va API ni hech qachon chaqirmaydi, shuning uchun uni istalgan joyda bemalol ishlatish mumkin.

Qarorga javob berish:

add_action( 'goxost_kyc_decision', function ( $user_id, $decision, $payload ) {
    // $decision: GREEN, RED or ON_HOLD
    // $payload: the webhook event (id, type, created_at, env, data) without document data
    if ( 'GREEN' === $decision ) {
        ( new WP_User( $user_id ) )->add_role( 'verified_customer' );
    }
}, 10, 3 );

Arizachi yaratilganda yuboriladigan maʼlumotni oʻzgartirish:

add_filter( 'goxost_kyc_applicant_data', function ( $payload, $user_id ) {
    $payload['purpose']  = 'Age check for alcohol orders';
    $payload['metadata'] = [ 'plan' => 'gold' ];
    return $payload;
}, 10, 2 );
Muhim

metadata ga shaxsiy maʼlumot qoʻshmang — API email va telefonni rad etadi, metadata da shaxsiy maʼlumot boʻlmasligi kerak. external_id ni oʻzgartirmang: webhooklar foydalanuvchilarga u orqali bogʻlanadi.