{% extends 'base.html.twig' %} {% block body %}

Comment utiliser l'API BILEMO

L'api regroupe un catalogue de téléphone mobile utilisé dans l'entreprise Bile Mo.
Vous pourrez retrouver les informations nécessaires aux utilisateurs liés à votre compte client.
API En savoir plus

Voici plusieurs solutions pour utiliser l'api :

Postman : c'est un logiciel qui va vous permettre d’appeler / tester une API.
Api platform : L'outil utilisé à la création de l'api peut être utilisé pour appeler / tester une API plus visuel que l'utilisation Postman

  1. Connexion compte client
  2. Consulter la liste des produits BileMo
  3. Consulter les détails d’un produit BileMo
  4. Consulter la liste des utilisateurs inscrits liés à un client sur le site web
  5. Consulter le détail d’un utilisateur inscrit lié à un client
  6. Ajouter un nouvel utilisateur lié à un client
  7. Supprimer un utilisateur ajouté par un client

Connexion compte client

Sur l'interface de l'api Bilemo vous pourrez vous connecter pour accéder aux ressources de vos utilisateurs.
Vous allez avoir besoin d'un token pour valider la connexion au service de l'api, dans la partie authentification cliquer sur la route GET /api/login_check.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Nous utilisons l'écriture au format JSON, c'est un langage léger d’échange de données textuelles. Remplacer les données par vos accès personnels, attention il vous faudra garder la forme écrite du JSON pour que la requête soit fonctionnelle.

bilemo

Après vérifications de vos identifiants l'api retourne le TOKEN, il va être utilisé pour vous identifier, copier le token sans les guillemets

bilemo

Accéder à la partie autorisation.

bilemo

Ajouter bearer et coller le TOKEN

bilemo

Sur l'interface de l'api Bilemo vous pourrez vous connecter pour accéder aux ressources de vos utilisateurs.
Vous allez avoir besoin d'un token pour valider la connexion au service de l'api, ajouter l'url GET /api/login_check.

bilemo

Nous utilisons l'écriture au format JSON,c'est un langage léger d’échange de données textuelles.
Remplacer les données par vos accès personnels, attention il vous faudra garder la forme écrite du JSON pour que la requête soit fonctionnelle.
Ajouter dans le Body -> row { "username": "monAdresseEmail@gmail.com", "password": "password" }

bilemo

Il va falloir spécifier à POSTMAN le format d'écriture à utiliser, il faut ajouter dans la partie headers KEY : Content-Type / Value : application/json

bilemo

Exécuter la requête et voici le TOKEN. Copier le sans les guillemets

bilemo

Consulter la liste des produits BileMo

Accéder à la liste des produits et cliquer sur la route GET /api/mobiles.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Les produits sont renvoyés sous forme de pagination sélectionner la page et exécuter la requête

bilemo

Voici la liste des produits

bilemo

Ajouter l'url GET /api/mobiles.

bilemo

Dans la partie Authorization sélectionner Type : Bearer Token et copier le TOKEN dans le champ. Si vous n'avez pas encore de TOKEN : Connexion compte client

bilemo

Exécuter la requête et voici la liste des produits

bilemo

Consulter les détails d’un produit BileMo

Accéder aux détails d'un produit puis cliquer sur la route GET /api/mobiles/{id}.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Ajouter l'id du produit à séléctionner.

bilemo

Voici le détail du produit

bilemo

Ajouter l'url GET /api/mobiles/{id}
Remplacer {id} par l'id du produit à seléctionner

bilemo

Dans la partie Authorization sélectionner Type : Bearer Token et copier le TOKEN dans le champ. Si vous n'avez pas encore de TOKEN : Connexion compte client

bilemo

Exécuter la requête et voici les détails d'un produit

bilemo

Consulter la liste des utilisateurs inscrits liés à un client sur le site web

Accéder à la liste des utilisateurs et cliquer sur la route GET /api​/utilisateurs.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Les utilisateurs sont renvoyés sous forme de pagination. Sélectionner la page et exécuter la requête

bilemo

Voici la liste des utilisateurs

bilemo

Ajouter l'url GET /api/utilisateurs.

bilemo

Dans la partie Authorization sélectionner Type : Bearer Token et copier le TOKEN dans le champ. Si vous n'avez pas encore de TOKEN : Connexion compte client

bilemo

Exécuter la requête et voici la liste des utilisateurs

bilemo

Consulter le détail d’un utilisateur inscrit lié à un client

Accéder aux détails d'un utilisateur et cliquer sur la route GET /api/utilisateurs/{id}.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Ajouter l'id de l'utilisateur à séléctionner.

bilemo

Voici le détail de l'utilisateur

bilemo

Ajouter l'url GET /api/utilisateurs/{id}. Remplacer {id} par l'id de l'utilisateur à seléctionner

bilemo

Dans la partie Authorization sélectionner Type : Bearer Token et copier le TOKEN dans le champ. Si vous n'avez pas encore de TOKEN : Connexion compte client

bilemo

Exécuter la requête et voici le détail de l'utilisateur

bilemo

Ajouter un nouvel utilisateur lié à un client

Pour ajouter un utilisateur POST /api/utilisateurs.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Ajouter les imformations de l'utilisateur puis supprimer la ligne client. Il sera rempli automatiquement, il faut supprimer la virgule à la dernière ligne

bilemo

Voici le détail du produit

bilemo

Ajouter l'url POST /api/utilisateurs.

bilemo

Dans la partie Authorization sélectionner Type : Bearer Token et copier le TOKEN dans le champ. Si vous n'avez pas encore de TOKEN : Connexion compte client

bilemo

Il va falloir spécifier à POSTMAN le format d'écriture à utiliser, il faut ajouter dans la partie headers KEY : Content-Type / Value : application/json

bilemo

Nous utilisons l'écriture au format JSON, c'est un langage léger d’échange de données textuelles.
Remplacer les données par vos accès personnels, attention il vous faudra garder la forme écrite du JSON pour que la requête soit fonctionnelle.
Ajouter dans le Body -> row
{
  "firstname": "Antoine",
  "lastname": "lafayette",
  "email": "antoine@gmail.com",
}

bilemo

Exécuter la requête, l'utilisateur à été ajouté

bilemo

Supprimer un utilisateur ajouté par un client

Supprimer les ressources d'un client et cliquer sur la route DELETE /api/utilisateurs/{id}.

bilemo

Cliquer sur le bouton "try it out".

bilemo

Ajouter l'id de l'utilisateur à supprimer.

bilemo

Le code 204 nous retourne le bon fonctionnement de la suppression

bilemo

Ajouter l'url DELETE /api/utilisateurs/{id}. Remplacer {id} par l'id de l'utilisateur à supprimer

bilemo

Dans la partie Authorization sélectionner Type : Bearer Token et copier le TOKEN dans le champ. Si vous n'avez pas encore de TOKEN : Connexion compte client

bilemo

Exécuter la requête, le Status 204 est retourné par l'api la ressource a donc été supprimé.

bilemo
{% block javascripts %} {% endblock %} {% endblock %}