verify
verify — 2 işlem (POST /v1/apps/{appId}/verify/sms, POST /v1/apps/{appId}/verify/sms/check). OpenAPI 3.1.0 sözleşmesinden üretilir.
Taban adres: https://api.pushizo.com · Etiket: verify · Etkileşimli belge (Scalar)
İşlemler
| Yöntem | Yol | İşlem |
|---|---|---|
POST | /v1/apps/{appId}/verify/sms | SMS doğrulama kodu gönder |
POST | /v1/apps/{appId}/verify/sms/check | SMS doğrulama kodunu kontrol et |
Ayrıntılar
SMS doğrulama kodu gönder
Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: StartVerifyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
phone | string | Evet | Uzunluk: 8–20 |
locale | string | Hayır | Uzunluk: 2–12 |
Örnek:
{
"phone": "+905321234567",
"locale": "tr"
}Yanıtlar
201 — Başarılı.
Şema: SmsVerification
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | |
expires_at | string | Evet |
Örnek yanıt:
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"expires_at": "örnek"
}Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).
Örnekler
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/verify/sms" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "+905321234567",
"locale": "tr"
}'SMS doğrulama kodunu kontrol et
Kimlik doğrulama: API anahtarı (Authorization: Bearer hs_live_…).
Parametreler
| Ad | Konum | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|---|
appId | yol | string | Evet | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
İstek gövdesi (zorunlu)
Şema: CheckVerifyDto
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | Evet | Uzunluk: 4–80 |
code | string | Evet |
Örnek:
{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"code": "değer"
}Yanıtlar
200 — Başarılı.
Şema: SmsVerificationCheck
| Alan | Tür | Zorunlu | Açıklama |
|---|---|---|---|
verified | true | Evet |
Örnek yanıt:
{
"verified": true
}Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).
Örnekler
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/verify/sms/check" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"code": "değer"
}'