Action d'API personnalisée

Adressez un appel d'API personnalisé aux API Vérifier ou Soumettre d'Evident ID.

Remarque :

Cette carte prend en charge uniquement les API de production. Les API Sandbox, également appelées API de démonstration, ne sont pas prises en charge.

Options

Champ Définition Type Obligatoire

Champ	Définition	Type	Obligatoire
API	Sélectionnez l'API appropriée à interroger : `Verify` ou `Submit`.	Liste déroulante	TRUE
Type de requête	Il s'agit de l'une des méthodes de requête HTTP prises en charge, ou de verbes HTTP, dans un appel d'API personnalisé (consultez Méthodes de requête HTTP). `GET` : récupère des données d'un serveur Web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête aboutit, un message de réponse `200 (OK)` est renvoyé avec le contenu demandé. `POST` : envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent produire un résultat différent de celui d'une seule requête POST. Soyez prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête aboutit, un message de réponse `200 (OK)` est renvoyé. `PUT` : envoie des données à stocker à un emplacement spécifique sur un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse `200 (OK)`, `201 (Created)` ou `204 (No Content)` est retourné. `PATCH` : Applique des modifications partielles à une ressource sur un serveur web en fonction des paramètres. PATCH n'est pas idempotente. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si une requête PATCH réussit, un message de réponse `200 (OK)` ou `204 (No Content)` est renvoyé. `DELETE` : supprime la ressource spécifiée (si elle existe) du serveur Web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse `200 (OK)` est renvoyé.	Liste déroulante	TRUE

API

Sélectionnez l'API appropriée à interroger : Verify ou Submit.

Liste déroulante

TRUE

Type de requête

Il s'agit de l'une des méthodes de requête HTTP prises en charge, ou de verbes HTTP, dans un appel d'API personnalisé (consultez Méthodes de requête HTTP).

GET : récupère des données d'un serveur Web en fonction des paramètres. Cette méthode demande une représentation de la ressource spécifiée. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé avec le contenu demandé.
POST : envoie des données à un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Plusieurs requêtes POST peuvent produire un résultat différent de celui d'une seule requête POST. Soyez prudent pour éviter d'envoyer plusieurs requêtes POST par inadvertance. Si une requête aboutit, un message de réponse 200 (OK) est renvoyé.
PUT : envoie des données à stocker à un emplacement spécifique sur un serveur Web en fonction des paramètres (par exemple, le chargement d'un fichier). Contrairement aux requêtes POST, les requêtes PUT sont idempotentes. Pour les requêtes réussies, le résultat d'une seule requête PUT est le même que plusieurs requêtes PUT identiques. Si une requête réussit, un message de réponse 200 (OK), 201 (Created) ou 204 (No Content) est retourné.
PATCH : Applique des modifications partielles à une ressource sur un serveur web en fonction des paramètres. PATCH n'est pas idempotente. Plusieurs requêtes PATCH pourraient avoir des conséquences non souhaitées. Si une requête PATCH réussit, un message de réponse 200 (OK) ou 204 (No Content) est renvoyé.
DELETE : supprime la ressource spécifiée (si elle existe) du serveur Web en fonction des paramètres. Si une requête DELETE aboutit, un message de réponse 200 (OK) est renvoyé.

Liste déroulante

TRUE

Entrée

Champ	Définition	Type	Obligatoire
Utilisateur
URL relative	L'adresse URL du serveur Web que vous essayez d'appeler. Spécifiez l'URL relative comme `/{insert_remaining_URL}`. Vous pouvez spécifier des paramètres de requête dans l'URL relative à l'aide de `?`, ou spécifier les paramètres de requête sous forme de paire clé/valeur dans l'entrée Requête. Par exemple, pour le point de terminaison de l'API Evident ID : Vérifiez la production : `https://verify.api.evidentid.com/api/v1/verify/requestTemplates` l'URL relative est : `/verify/requestTemplates`. Soumettre une production : `https://submit.api.evidentid.com/api/v1/requests` l'URL relative est : `/requests`. Voir Evident IDDocumentation API.	Texte	TRUE
Requête	Spécifiez tous les paramètres de requête supplémentaires qui doivent être inclus sous forme de paires clé/valeur. Par exemple, `{"name":"something-urgent"}`.	Objet	FALSE
En-têtes	Spécifiez tous les en-têtes requis en plus de `authorization` ou `content-type`, puisque le connecteur gère déjà ces en-têtes.	Objet	FALSE
Corps	Spécifiez un corps de requête au format JSON. Cette entrée n'est disponible que pour les requêtes `POST`, `PUT` et `PATCH`.	Objet	FALSE

Sortie

Champ	Définition	Type
Réponse
Code de statut	Résultat de l'opération. Le connecteur retourne un code de statut HTTP qui indique si l'action effectuée par la carte a réussi ou échoué. Par exemple : Un code de statut `201 Created` indique un succès où une nouvelle ressource a été créée. Une erreur `403 Forbidden` indique que la requête HTTP n'a pas été traitée parce que les permissions nécessaires étaient manquantes. Pour une liste complète des codes de statut possibles, voir Codes de statut HTTP.	Nombre
En-têtes	Contexte détaillé du code de statut, sans lien avec le corps de la sortie. Les en-têtes de réponse dépendent de l'option de requête HTTP sélectionnée. Tous les en-têtes ne sont pas des en-têtes de réponse. Ceci est semblable à `{"Content-type":"application/json"}`.	Objet
Corps	Données retournées par votre requête HTTP sélectionnée. Par exemple, les données d'une requête `GET`.	Objet

Appeler l'API Vérifier pour créer une requête

Dans le menu déroulant API, sélectionnez Verify.
Dans le menu déroulant Type de requête, sélectionnez POST, puis cliquez sur Enregistrer.
Sélectionnez toutes les entrées de la requête, puis cliquez sur Enregistrer.
Saisissez /verify/requests dans le champ URL relative.
Saisissez la requête dans le champ Corps. Par exemple, l'entrée suivante demande des données pour un permis de conduire :

{
    "description": "Upload license",
    "email": "output@example.com",
    "attributesRequested": 
	[
        {"attributeType": "core.firstname"},
        {"attributeType": "core.lastname"},
        {"attributeType": "core.address.fulladdress"},
        {"attributeType": "identity_assurance.document_verification.americas.us.verification_status"}
    ]
}

L'API renvoie un Corps qui contient un ID. Utilisez cet ID dans la requête suivante.

Obtenir la valeur userIdentityToken

Dans le menu déroulant API, sélectionnez Verify.
Dans le menu déroulant Type de requête, sélectionnez GET, puis cliquez sur Enregistrer.
Dans le champ URL relative, saisissez une valeur similaire à /verify/requests/{id}/authToken.

Cette étape vous permettra d'obtenir le jeton de porteur de l'utilisateur et l'ID de la requête. Le jeton de porteur vous permettra d'appeler l'API Submit pour soumettre des données.

Appeler l'API Soumettre pour soumettre des données

Dans le menu déroulant API, sélectionnez Submit.
Dans le menu déroulant Type de requête, sélectionnez POST, puis cliquez sur Enregistrer.
Dans le champ Corps, ajoutez une entrée, par exemple :

{
    "Request:": 
	{
        "Relative URL": "/requests",
        "metadata": "getHttpInputs",
		"config": "",
        "Headers": 
		{
            "Accept": "application/json",
            "Content-Type": "application/json",
            "Authorization": "Bearer <bearer token obfuscated>"
        },
        "Body": 
		{
            "inputs": 
			[
	                {
	                    "type": "core.firstname",
	                    "value": "Workflows"
	                },
	                {
	                    "type": "core.lastname",
	                    "value": "Test"
	                },
	                {
	                    "type": "certifications.servsafe.servsafe_food_handler.certnumber",
	                    "value": "1234567"
	                }
	            ]
        		}
    		}
}

Notez les valeurs des champs URL relative et En-têtes.

L'API Submit vous permet de soumettre des données en utilisant le jeton de porteur de l'utilisateur de l'étape précédente.