Introduction Dernière mise à jour:

Bienvenue dans la référence de l'API WSE_FLEXBOX .
L'API est organisée autour de REST. L'API accepte les corps de requête codés par formulaire, renvoie des réponses codées JSON et utilise des codes de réponse HTTP standard et une authentification .

Endpoints

Tous les appels à l'API doivent commencer par l'URL de base approprié :

https://dev-wse-flexbox.flexi-tek.com/api/v1

Appels API

Curl

Utilisation de curl pour appeler l'API, vous devez include l'URL de la ressource entre guillemets lorsque vous passez plusieurs paramètres de rêquete séparés par un &.

curl -v \ -H "Content-Type: application/json" \ -H "Authorization: 3eafcfbd-6041-47e0-9475-ff082fbc3a79" \ -X GET "https://dev-wse-flexbox.flexi-tek.com/api/v1/endpoint?offset=10&limit=10"

Postman

Postman est une plateforme de collaboration pour tester les API.

Swagger

Tester les appels API directement depuis la documentation générée Swagger.

Exécuter dans Swagger

Réponses API

Cette API utilise des codes de réponse HTTP conventionnels pour indiquer le succès ou l'échec d'une demande d'API.
En général:
les codes de la gamme 2xx indiquent le succès.
Les codes de la plage 4xx indiquent une erreur qui a échoué compte tenu des informations fournies (par exemple, un paramètre requis a été omis, une charge a échoué, etc.).
Les codes de la gamme 5xx indiquent une erreur avec le serveur.
Les erreurs répondent avec un code d'erreur et JSON qui contient un message.

Exemple d'une réponse

201 Created


{
  "message": "Client successfully created",
  "Client": {
    "name": "Jhon doe",
    "email": "jhon-doe@example.com",
    "updated_at": "2021-03-08T15:19:28.000000Z",
    "created_at": "2021-03-08T15:19:28.000000Z",
    "id": 48
  }
}

Exemple d'erreur

422 Unprocessable Entity

{
       "errors": [
        {
        "Message": "The id must be at least 1."
        }
        ]
}

Tableau des erreurs

CODE	NOM DU STATUT	DESCRIPTION	ACTION SUGGÉRÉE
400	Bad Request	Il y a un problème avec votre demande.	Vérifiez que votre demande respecte la documentation de l'API et utilise la syntaxe correcte.
401	Unauthorized	Vous ne disposez pas de l'autorisation nécessaire pour effectuer la demande.	Assurez-vous que vous utilisez une clé API valide avec les autorisations nécessaires pour votre demande.
401	Forbidden	Le serveur a compris la demande mais a refusé de la satisfaire.	Modifiez l'URL de votre demande pour qu'elle corresponde à un point de terminaison d'API valide.
404	Not Found	Le serveur n'a pas pu trouver le fichier demandé.	Vérifiez si l'API inclut la ressource que vous demandez et si votre clé API dispose des autorisations nécessaires.
405	Method Not Allowed	La ressource n'a pas la méthode spécifiée. (par exemple PUT sur les transmissions)	Modifiez la méthode pour suivre la documentation de la ressource.
409	Conflict	Un conflit est né de votre demande. (par exemple, l'utilisateur existe déjà avec cet e-mail)	Modifiez payload pour effacer le conflit.
422	Unprocessable Entity	La requête était syntaxiquement correcte mais a échoué en raison d'erreurs sémantiques.	Assurez-vous que votre demande comprend tous les champs obligatoires et que vos données sont valides.
500	Internal Server Error	Un problème est survenu de notre côté.)	Réessayez la demande plus tard. Si l'erreur ne résout pas, consultez notre page d'état pour les mises à jour du service. Vous pouvez également contacter l'assistance depuis l'application [EU] si votre problème persiste.
503	Service Unavailable	Nous connaissons des niveaux de trafic supérieurs à la normale.	Réessayez la demande plus tard.