> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Informazioni sull'identità e istruzioni per l'integrazione dell'API di verifica della validità
> Identity Authentication 集成指南 - XHuoAPI
Questo documento introduce un'API di verifica delle informazioni sull'identità e della validità, che può essere utilizzata per convalidare la veridicità e la coerenza del nome, del numero di carta d'identità e della validità della carta d'identità.
## Processo di richiesta
Per utilizzare l'API, è necessario prima andare alla pagina corrispondente dell'[API di verifica delle informazioni sull'identità e della validità](https://api.xhuoapi.ai/documents/667017a4-017f-4af0-870e-807034f70632) per richiedere il servizio corrispondente. Una volta entrati nella pagina, fare clic sul pulsante "Acquire", come mostrato nell'immagine:
Se non si è ancora effettuato il login o la registrazione, si verrà automaticamente reindirizzati alla pagina di accesso per invitare a registrarsi e accedere. Dopo aver effettuato il login o la registrazione, si verrà automaticamente riportati alla pagina corrente.
Alla prima richiesta, verrà offerto un credito gratuito, che consente di utilizzare gratuitamente l'API.
## Utilizzo di base
Innanzitutto, è importante comprendere il modo di utilizzo di base, che consiste nell'inserire il link all'immagine della carta d'identità per ottenere il risultato di verifica elaborato. È necessario prima trasmettere un campo `name`, e successivamente si possono compilare i contenuti corrispondenti nell'interfaccia, come mostrato nell'immagine:
Si può notare che qui abbiamo impostato le intestazioni della richiesta, che includono:
* `accept`: il formato della risposta desiderata, qui impostato su `application/json`, ovvero formato JSON.
* `authorization`: la chiave per chiamare l'API, che può essere selezionata direttamente dopo la richiesta.
Inoltre, sono state impostate le informazioni del corpo della richiesta, che includono:
* `name`: nome.
* `id_card`: numero della carta d'identità.
* `image_url`: link all'immagine del volto da elaborare.
* `validity_end`: data di scadenza della validità della carta d'identità, formato: YYYYMMDD, per validità a lungo termine utilizzare "00000000";
* `validity_begin`: data di inizio della validità della carta d'identità, formato: YYYYMMDD.
* `encryption`: opzionale, parametro di crittografia per campi sensibili (se è necessario inviare dati crittografati).
Dopo aver selezionato, si può notare che a destra è stato generato il codice corrispondente, come mostrato nell'immagine:
Cliccando sul pulsante "Try" è possibile effettuare un test, come mostrato nell'immagine sopra, e si ottiene il seguente risultato:
```json theme={null}
{
"result": "0",
"description": "Coerente"
}
```
Il risultato restituito contiene diversi campi, descritti di seguito:
* `result`, codice del risultato di autenticazione, le condizioni di addebito sono le seguenti.
* Codici di risultato a pagamento:
* 0: Nome e numero della carta d'identità coerenti
* -1: Nome e numero della carta d'identità non coerenti
* Codici di risultato non a pagamento:
* -2: Numero della carta d'identità non valido (lunghezza, cifra di controllo, ecc. non corretti)
* -3: Nome non valido (lunghezza, formato, ecc. non corretti)
* -4: Anomalia nel servizio del database dei documenti
* -5: Nessun record di questa carta d'identità nel database
* -6: Sistema di confronto autorevole in fase di aggiornamento, riprovare più tardi
* -7: Numero di autenticazioni superato il limite giornaliero.
* `description`, qui il risultato della verifica tra nome e numero della carta d'identità.
Si può notare che il nome, il numero della carta d'identità e la validità della carta d'identità presentano veridicità e coerenza.
Inoltre, se si desidera generare il codice di integrazione corrispondente, è possibile copiarlo direttamente, ad esempio il codice CURL è il seguente:
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/identity/idcard/check-2e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"name": "***",
"id_card": "***",
"validity_begin": "***",
"validity_end": "***"
}'
```
Il codice di integrazione in Python è il seguente:
```python theme={null}
import requests
url = "https://api.xhuoapi.ai/v1/identity/idcard/check-2e"
headers = {
"accept": "application/json",
"authorization": "Bearer {token}",
"content-type": "application/json"
}
payload = {
"name": "***",
"id_card": "***",
"validity_begin": "***",
"validity_end": "***"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
```
## Gestione degli errori
Quando si chiama l'API, se si verifica un errore, l'API restituirà il codice di errore e le informazioni corrispondenti. Ad esempio:
* `400 token_mismatched`: Richiesta non valida, probabilmente a causa di parametri mancanti o non validi.
* `400 api_not_implemented`: Richiesta non valida, probabilmente a causa di parametri mancanti o non validi.
* `401 invalid_token`: Non autorizzato, token di autorizzazione non valido o mancante.
* `429 too_many_requests`: Troppe richieste, hai superato il limite di frequenza.
* `500 api_error`: Errore interno del server, qualcosa è andato storto sul server.
### Esempio di risposta di errore
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## Conclusione
Attraverso questo documento, hai appreso come utilizzare l'API di verifica delle informazioni sull'identità e della validità per convalidare la veridicità e la coerenza del nome, del numero della carta d'identità e della validità della carta d'identità. Speriamo che questo documento possa aiutarti a integrare e utilizzare meglio l'API. Se hai domande, non esitare a contattare il nostro team di supporto tecnico.