Requêtes

Effectuer une requête

Hôte

L'hôte des requêtes Web API v1 est toujours https://api.iafcertsearch.org/api/client/v1

Toutes les requêtes doivent être effectuées via HTTPS. L'API ne prend pas en charge HTTP.

En-tête d'autorisation

Vous devez fournir un en-tête d'autorisation tel que décrit dans Authentication.

Verbes HTTP

• GET Récupérer une ressource ou un groupe de ressources

• POST Créer une nouvelle ressource

• PUT Mettre à jour une ressource existante

• DELETE Supprimer une ressource existante

• OPTIONS Afficher les verbes autorisés pour une ressource spécifique

En-tête Accept

L'API fournit des réponses JSON. Elle ne nécessite pas encore l'en-tête accept, mais pourrait le faire à l'avenir. S'il n'est pas défini, l'API utilisera application/json.

GET https://api.iafcertsearch.org/api/client/v1/endpoint HTTP/1.1
Accept: application/json

Tableaux de données

Lorsque vous envoyez un tableau de données dans une requête GET, vous devez inclure le paramètre plusieurs fois dans l'URL. Le nom du paramètre ne nécessite pas de crochets.

GET https://api.iafcertsearch.org/api/client/v1/endpoint?parameter=data1&parameter=data2 HTTP/1.1

Formatage de votre requête

Corps de la requête

Lorsque vous soumettez des données à une ressource via POST ou PUT, vous devez soumettre votre charge utile en JSON.

POST https://api.iafcertsearch.org/api/client/v1/example/ HTTP/1.1
Content-Type: application/json

{
  "name": "nouveau nom d'exemple"
}

Pagination

Certaines ressources GET permettent de récupérer des informations par lots. Nous fournirons les paramètres de requête dans la documentation de la ressource lorsque cela est possible.

Lors de la demande de plusieurs éléments, nous définirons par défaut la limite de la requête à 20 éléments. Vous pouvez spécifier une limite différente à l'aide du paramètre limit lorsque vous en avez besoin. La valeur maximale du paramètre limit que nous acceptons est 100.

Ci-dessous, vous pouvez voir un exemple de requête API qui récupère les 100 premiers enregistrements spécifiés par les paramètres limit=100 et offset=0.

Pour récupérer le lot suivant d'enregistrements, incrémentez le paramètre offset de 1.

GET https://api.iafcertsearch.org/api/client/v1/resource?limit=100&offset=0 HTTP/1.1

Requêtes réussies

Verbe	Objet de ressource retourné
GET	Renvoie un seul objet de ressource ou un tableau d'objets de ressources
PATCH	Renvoie l'objet de ressource mis à jour
PUT	Renvoie l'objet de ressource mis à jour
DELETE	Aucun contenu n'est renvoyé
POST	Renvoie l'objet de ressource nouvellement créé