Paramètres de la demande

Ce document décrit les différents paramètres de demande qui doivent être définis pour un point de terminaison de l'API ou une ressource cible lors d'un appel de demande d'API.

Selon le noeud final de l'API ou la ressource cible, vous devrez peut-être définir les paramètres suivants dans votre appel de demande d'API :

Form data

Utilisez ces paramètres pour demander un jeton d'accès dont votre client API a besoin pour les appels de demande d'API suivants :

Tableau 1. Paramètres de données de formulaire
Paramètres	Descriptif
client_id	ID client affecté au client API.
client_secret	Secret client affecté au client API.
grant_type	Défini sur `client_credentials`.
scope	Liste de portées délimitées par des espaces, associée à ce jeton. La portée valide pour les clients API est `openid`.

En-têtes

Verify requiert les informations suivantes dans l'en-tête HTTP :

Tableau 2. Paramètres d'en-tête
Paramètres	Descriptif
Content Type	Dans un en-tête de requête, indique le type de données que le client a envoyé au serveur. Dans un en-tête de réponse, indique le type de données renvoyé au client. Exemple : `-H "Content-type: application/json"`
Accept	Indique le type de contenu que le client peut comprendre et accepter dans une réponse. Exemple : `-H "Accept: application/json" -H "Accept: image/png"`
Location	URL de l'objet créé dans l'en-tête de la méthode HTTP POST. Par exemple, `/<resource-noun>/<resource-id>`.
Accept-Language	Langue que le client comprend ou préfère.

Paramètres de requête

Les paramètres suivants sont facultatifs, en fonction de la manière dont vous souhaitez renvoyer les résultats de votre demande d'API.

Tableau 3. Paramètres de requête
Paramètres	Descriptif
pagination	Si aucun paramètre de pagination n'est transmis, tous les résultats sont renvoyés. La valeur maximale autorisée pour la limite ou le nombre est de 1000. `count` est le nombre total de résultats devant être renvoyés par le magasin de données. `page` est la page demandée. `limit` est le nombre total de résultats à renvoyer dans une page.
sort	Chaque attribut doit être précédé de + ou - (+ croissant, - descendant). Les attributs multiples doivent être séparés par une virgule (,).
search	Opérateurs valides pour : Les chaînes sont `= , !=` et `contains` Les valeurs booléennes sont `=` et `!=` Les nombres sont `>=`, `>`, `<=`, `<`, `=`et `!=`
filter	Les formats valides sont inclusifs uniquement ou exclusifs uniquement. Les paramètres de filtre multiples doivent être séparés par une virgule (,).

Corps

Utilisez ce paramètre pour les requêtes POST, PUT et PATCH. Définissez ici les attributs et les valeurs à créer ou à mettre à jour. Cliquez sur le type de données Model ou Example Value pour afficher les attributs que vous devez définir dans le corps, y compris le format et la valeur d'exemple.

Le type de contenu de paramètre est application/json. Le contenu est stocké au format de fichier JSON.