Ana içeriğe geç
ShieldID

Geliştiriciler

Gerçekten kullanmak için tasarlanmış kimlik doğrulama API belgeleri.

Tek bir REST API, kendiniz oluşturmak istemediğiniz kısımlar için barındırılan bir sayfa ve sonuç hazır olduğu anda haberdar olmanızı sağlayan imzalı webhook'lar. Sandbox anahtarları asla faturalandırılmaz; dolayısıyla ShieldID'yi anlamanın en hızlı yolu onu çağırmaktır.

Sandbox'ta ücretsiz başlayınHızlı başlangıç kılavuzunu okuyun

Beş dakikalık özet

Dört çağrı. Tek bir zihinsel model.

Bu belgelerdeki diğer her şey, bu döngünün üzerine eklenen ayrıntılardır.

  1. Bir oturum oluşturun

    Bir dönüş URL'si ve bir webhook URL'si ile POST /v1/sessions çağrısı yapın. Karşılığında bir session_id ve bir verification_url alırsınız.

  2. Başvuru sahibine iletin

    verification_url değerini bağlantı olarak gönderin veya masaüstünde barındırılan sayfanın gösterdiği QR kodunu taratın. İşlemi kendi telefonlarında tamamlarlar.

  3. İmzalı bir webhook alın

    Oturum VERIFIED veya FAILED durumuna ulaştığında ShieldID, sonucu webhook URL'nize POST eder; sonucun bizden geldiğine güvenebilmeniz için imzalanmıştır.

  4. Sonucu okuyun

    Webhook'a güvenin veya GET /v1/sessions/{id}/result çağrısını kendiniz yapın. Her iki durumda da tek bir opak puan yerine kontrol başına sonuçlar alırsınız.

Deneyin

İlk oturumunuzu oluşturun.

Aynı istek üç dilde. Zihinsel modelin ilk adımının anlattığı çağrı budur.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

Sandbox anahtarları (vk_sand_…) bu akışın aynısını ücretsiz çalıştırır. Bir vk_live_ anahtarına geçtiğinizde fatura dışında hiçbir şey değişmez.

Yolunuzu bulun

Geliştirici belgelerinin geri kalanı.

Altı sayfa. İhtiyacınız olanları okuyun.

API referansı

Her uç nokta, her alan, önceden planlayabileceğiniz her hata.
Aç API referansı

SDKs

Web widget'ı, barındırılan akış ve gelecek olanlar.
Aç SDKs

Sandbox

Test modu nasıl çalışır ve nasıl anahtar alınır.
Aç Sandbox

Durum

Akış yayına girdiğinde neleri raporlayacağız.
Aç Durum

Sandbox

İmzalamadan önce tüm akışı test edin.

Bir sandbox anahtarı (ön eki vk_sand_) üretim ortamıyla aynı API'yi, barındırılan sayfayı ve webhook akışını çalıştırır. Oturumlar göründükleri her yerde environment: "sandbox" olarak işaretlenir ve sandbox oturumları hiçbir planda ücretlendirilmez.

Sandbox kılavuzunu okuyun
  • Gerçek oturumlar oluşturun, kendi telefonunuzda gerçek bir belgeyi doğrulayın, karşılığında gerçek ve imzalı bir webhook alın
  • Sandbox'ta yaptığınız hiçbir işlem faturaya yansımaz
  • Anahtar ön ekini değiştirerek üretime geçin; istek yapısı değişmez

Açıkça geliştiriyoruz

Nelerin tamamlandığı ve nelerin henüz tamamlanmadığı.

Entegrasyonun ortasında kendi başınıza fark etmenizdense size söylemeyi tercih ederiz.

Web widget tamamlanma geri çağrıları

Yakında

onComplete, onCancel ve onStep bugün widget arayüzünde mevcut, ancak henüz hiçbir şey bunları tetiklemiyor. Dönüş URL'sini ve webhook'u kullanın; ikisi de şu anda çalışıyor.

Uygulanan hız sınırları

Yakında

Her API anahtarının planınıza göre kaydedilmiş bir hız sınırı vardır, ancak bu sınır istekler üzerinde henüz uygulanmamaktadır; buna göre planlama yapın, istekleri sınırlamak için ShieldID'ye güvenmeyin.

Self-servis sandbox kaydı

Yakında

Self-servis kayıt geliştirilirken sandbox anahtarları talep üzerine verilmektedir. Talep edin, hızlıca hazırlayalım.

Sorular

Geliştiriciler için net yanıtlar.

Başlayın

Bir öğleden sonrada canlıya geçin.

Bir sandbox anahtarıyla başlayın, kendi telefonunuzda bir doğrulama çalıştırın ve size gönderdiği webhook'u inceleyin. Satış görüşmesi gerekmez.

Sandbox'ta ücretsiz başlayınHızlı başlangıç kılavuzunu okuyun

Sandbox oturumları asla faturalandırılmaz.