companyLogo

Doğrulama: SMS, WhatsApp, arama ve e-posta ile OTP kodları

Bir kişinin bir telefon numarasına sahip olduğunu kanıtlayın. Kodlar rastgele, tek kullanımlık, süreli ve size asla gösterilmez ya da açık saklanmaz.

sms
Telefonunuzdan SMS ile bir kod.
email
Echo kodu e-posta hesaplarınızdan biriyle e-posta ile gönderir; kişi yazar.
whatsapp
Bağlı numaranızdan WhatsApp ile bir kod.
phone_call
Echo numarayı arar ve çalarken kapatır; kişi arayan numarayı yazar.
missed_call
Kişi telefonunuzu arar; yazılacak kod yok.

Başlat

POST /v1/echo/verifications

channel isteğe bağlıdır. Verilmezse Echo, uygulamanızın kullandığı ve karşılayabildiği ilk yöntemi seçer: to bir adres ise e-posta; değilse WhatsApp, sonra SMS, sonra telefon araması, sonra cevapsız arama. Hiçbiri olamıyorsa yanıt 409 no_method_available olur.

Kodu kontrol edin

POST /v1/echo/verifications/VERIFICATION_ID/check

Telefon araması: Echo kişiyi arar

phone_call kanalıyla Echo, numarayı SIM'lerinizden biriyle arar ve çalmaya başlar başlamaz kapatır. Kişi kendisini arayan numarayı yazar; bunu /check'e code olarak gönderin (numaranın tamamı veya son 6 hanesi ya da daha fazlası; boşluk, + ve baştaki 0 sorun değildir). Yalnızca 2 yanlış deneme. API bu numarayı asla döndürmez. Yöntem, Echo'nun kaç farklı numaradan arayabildiği kadar güçlüdür; bu yüzden tek başına (tek yöntemi phone_call olan bir oturum veya tek bir kod) yalnızca o hedefi en az 20 farklı numara arayabiliyorsa kabul edilir; aksi halde sms, whatsapp veya missed_call ile birlikte kullanın.

POST /v1/echo/verifications/VERIFICATION_ID/check

Cevapsız arama ile doğrulama

missed_call ile kişiye call_to içindeki numarayı gösterin ve aramasını isteyin. Telefonunuz aramayı görür, kapatır ve doğrulama onaylanır. Sorgulayın veya webhook'u bekleyin.

  • Beş yanlış kod doğrulamayı sonlandırır (telefon aramasında iki yanlış numara).
  • Aynı numara için yeniden başlatmak yeni bir kod gönderir (en fazla 5 gönderim).
  • Kod, uygulamanızda ayarlanan süreden sonra geçersiz olur (varsayılan 10 dakika).
  • Her kod, kim gönderirse göndersin aynı tek satırı söyler: Your OTP is 123456; locale olarak ar ya da tr (Arapça veya Türkçe) istemedikçe İngilizce. Ona hiçbir şey eklenemez, marka adı bile.

Birden çok yöntem, tek müşteri

channel ve to yerine methods (ve email ve/veya phone) gönderin. Echo bir bağlantıyla yanıt verir: müşteri onu Echo'nun kendi sayfasında açar, her kodu sırayla ister ve yazar. require, kaç yöntemin doğrulanması gerektiğini söyler: 1'den tümüne kadar.

POST /v1/echo/verifications
  • Oturum oluşturulurken hiçbir şey gönderilmez. Müşteri her yöntem için, bir güvenlik doğrulamasındaki gibi, tek tek Kodu al'a dokunur.
  • Tüm yöntemler gerekliyse sırayla, tek tek yapılır. Daha azı gerekliyse müşteri hangilerini yapacağını seçer.
  • Her yöntemde kodlar arasında 60 saniye beklenir ve en fazla 3 kod gönderilir. Bir oturum 30 dakika sürer.
  • Her kod bir doğrulamadır: bir kodun maliyeti kadar tutar; uygulamanızın cihazları, anahtarları ve Echo cihazları her kodda olduğu gibi geçerlidir. Kod aynı sabit satırı söyler (locale en, ar veya tr).
  • Müşteri hiçbir zaman e-posta adresi ya da numara yazmaz: siz oturumu oluştururken verirsiniz, Echo bunları maskeli gösterir.
  • Oturum onaylandığında echo.verification.approved gönderilir. İsteğe bağlı return_url (https) sonda bir Devam et düğmesi ekler.

Bunun yerine kendi sayfanızı yapmak için: oturumu GET ile alın, sonra bir method ile POST /send ve method ile kodla POST /check yapın (oturumda tek yöntem varsa method atlanabilir).

POST /v1/echo/verifications/VERIFICATION_ID/send

Sayfayı gömmek ve kanıtı kullanmak

Müşteri sayfasını kendi sayfanızın içinde göstermek için oturumu oluştururken embed_origin verin (sayfanızın kökeni, https ya da localhost'ta http) ve bağlantıyı ?embed=1 ile açın (koyu sayfa için &theme=dark ekleyin). Yalnızca bu köken onu çerçeveleyebilir ve yalnızca bu köken sonucu alır.

  • Gömülü sayfa, olanları sayfanıza postMessage ile bildirir ve her zaman source: "echo" taşır: yüksekliği ({type: "resize", height}), sonuç ({type: "verified", proof}) ya da oturumun bittiği ({type: "ended"}) ve müşterinin kapattığı ({type: "closed"}). event.origin'in Echo'nun kökeni olduğunu denetleyin.
  • Sunucunuz kanıtı POST /v1/echo/verifications/redeem {proof} ile teslim eder: valid: true, doğrulanan yöntemler ve referansınız döner. Kanıt bir kez, yalnızca kendi uygulamanız için ve yalnızca onaylı bir oturum için çalışır.
  • reference (en çok 800 karakter) özel notunuzdur: Echo onu mühürlü tutar, müşteriye asla göstermez, kullanımda bir kez geri verir ve sonra siler.
  • skip_unavailable: true istediğiniz her şeyi ister ve uygulamanızın karşılayamadığını dışarıda bırakır (en az biri kalmalıdır). decoy: true gerçek görünen ama hiçbir şey göndermeyen, maliyeti olmayan ve asla başarılı olamayan bir oturum oluşturur; var olmayan bir ad için, böylece ekran hiçbir şey ele vermez.
POST /v1/echo/verifications/redeem

Belgeler

ibotek Echo