Bu API, belge doğrulama işlemleri için geliştirilmiş bir RESTful servistir. Tüm istekler için API key gereklidir ve HTTPS üzerinden yapılmalıdır.
Tüm API isteklerinde X-API-Key header'ı kullanılmalıdır:
headers: {
'X-API-Key': 'your_api_key',
'Content-Type': 'application/json'
}curl --location '${API_URL}/api/verify-document' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: your_api_key' \
--data '{
"documentType": "NUFUS_CUZDANI",
"mimeType": "image/png",
"documentUrl": "https://example.com/path/to/image.png",
"companyId": "işletmeye özel verilen id ",
"expectedValues": {
"TC Kimlik No": "11111111110",
"Ad": "Ümit Çelebi",
"Soyad": "SARITAŞ"
}
}'{
"isValid": true,
"documentType": "Nüfus Cüzdanı",
"fields": {
"TC Kimlik No": {
"isValid": true,
"expectedValue": "22771231094",
"detectedValue": "22771231094"
},
"Ad": {
"isValid": true,
"expectedValue": "Ümit Çelebi",
"detectedValue": "ÜMİT ÇELEBİ"
},
"Soyad": {
"isValid": true,
"expectedValue": "SARITAŞ",
"detectedValue": "SARITAŞ"
},
},
"error": null
}| Parametre | Zorunlu | Açıklama |
|---|---|---|
startDate |
Evet | Başlangıç tarihi (YYYY-MM-DD formatında) |
endDate |
Evet | Bitiş tarihi (YYYY-MM-DD formatında) verilen gün de dahil edilir. |
documentType |
Hayır | Belge tipi filtresi (NUFUS_CUZDANI, SGK_GIRIS_BILDIRGESI, ADLI_SICIL_BELGESI) |
ip |
Hayır | IP adresi filtresi |
companyId |
Hayır | Şirket ID filtresi |
curl --location '${API_URL}/api/logs?startDate=2025-04-01&endDate=2025-04-25&companyId=company123' \
--header 'X-API-Key: your_api_key'[
{
"timestamp": "2025-04-25T22:21:11.574Z",
"documentType": "Nüfus Cüzdanı",
"ip": "::1",
"companyId": "developer",
"startTime": "2025-04-25T22:21:02.887Z",
"duration": 8685,
"gptResponse": {
"isValid": false,
"documentType": "Nüfus Cüzdanı",
"fields": {
"TC Kimlik No": {
"isValid": true,
"expectedValue": "22771231094",
"detectedValue": "22771231094"
},
"Ad": {
"isValid": false,
"expectedValue": "Ümit Çelebi",
"detectedValue": "ÜMİT ÇELEBİ"
},
"Soyad": {
"isValid": false,
"expectedValue": "SARITAŞ",
"detectedValue": "SARITAŞ"
},
},
"error": "Beklenen değer ile belgedeki değer uyuşmuyor: Ad alanında büyük/küçük harf farkı dışında farklılık var."
},
"usage": {
"prompt_tokens": 2907,
"completion_tokens": 229,
"total_tokens": 3136,
"prompt_tokens_details": {
"cached_tokens": 0,
"audio_tokens": 0
},
"completion_tokens_details": {
"reasoning_tokens": 0,
"audio_tokens": 0,
"accepted_prediction_tokens": 0,
"rejected_prediction_tokens": 0
}
},
"error": null
}
]| Kod | Açıklama |
|---|---|
| 400 | Eksik veya geçersiz parametreler |
| 401 | API key eksik |
| 403 | Geçersiz API key |
| 500 | Sunucu hatası |