Documentation de l'API
Il s'agit de la documentation relative aux points d'accès à l'API disponibles, qui s'appuient sur l'architecture REST. Tous les points de terminaison de l'API renvoient une réponse JSON en utilisant les codes de réponse standard HTTP et requièrent une authentification par porteur via une clé API.
Authentification
Tous les points d'extrémité de l'API ont besoin d'une clé d'API envoyée via la méthode d'authentification par porteur..
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://staging.gratisqrcode.nl/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://staging.gratisqrcode.nl/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
Erreurs
Notre API utilise les codes de statut HTTP conventionnels pour indiquer la réussite ou l'échec d'une requête.
{
"errors": [
{
"title": "Vous n'avez pas acc\u00e8s \u00e0 l'API.",
"status": 401
}
]
}
200 Requête traitée avec succès
400 Requête incorrecte - Des paramètres requis sont manquants ou invalides
401 Non autorisé - La clé API est manquante ou invalide
404 La ressource demandée est introuvable
429 Trop de requêtes - Limite de débit dépassée
500 Erreur interne du serveur - cela signifie qu'il y a un problème de notre côté
Tous les résultats des points de terminaison de l'API fonctionnent avec le fuseau horaireUTC, sauf indication contraire.