Il est très simple d’utilisé l’API PHPReaction puiqu’il s’agit d’URL HTTP… donc de liens internets « web address ». Par exemple : https://www.google.com

Pas besoin de logiciel ou outil spécialisé.

Donc à tout moment, vous pouvez copier un lien en texte et le collé dans votre barre de navigation « address bar » de votre fureteur internet « web browser« . Notre navigateur de préférence est « Google Chrome Web Browser« 

Vous pourriez même utiliser l’interface de documentation dynamique conformément au standard Open API Support « OAS » / Swagger pour faire des demandes simple

Bien entendu, certaine extension peuvent être pertinent pour les utilisateurs les plus intensifs.

• JSON formater ou directement en extention Chrome pour l’affichage & navigation des réponses JSON
• PostMan pour découvrir / apprendre / tester l’API

Pour les utilisateurs plus avancé :

Les administrateurs de système vous pourrez utiliser l’outil de votre choix comme CURL ou autre CLI…

Les développeurs & programmeurs vous pourrez utiliser la librairie « HTTP Client » et le langage de votre choix.
Par exemple :

• PHP
  • Guzzle
  • Curl
    • Par Exemple Traductions et Relations d’API
• JavaScript JS
  • XMLHTTPRequest
  • jQuery – ajax()
  • Axios
  • Angular
• …

Vous devez toujours obtenir une clé d’accès temporaire * (« access token« )

Il s’agit d’une suite de chiffre et lettre minuscule et majuscule d’environ 85 caractères

Ex : MTcyNWNjM2JjMzNmMTI3NzNiNzFiYjk1YmQxNDEwNGQ5ODdlNDgzOWE1MzMwNzFmYmU4NjNmN2u0NWVlZmNiZ1

Suite à l’obtention de votre clé / « access token », vous pourrez l’utiliser sur des ressources spécifiques ( Voir la section « Ressources »)

Il y a 3 méthodes d’obtenir une clé

1. Déjà avoir une clé valide
2. Récupérer une clé manuellement (Ci-dessous)
3. Récupérer une clé par authentification (Ci-dessous)

* Le délais d’expiration « TTL » de votre clé / « token » est selon les configurations du projet. Celle-ci sera de 1h jusqu’à 24h maximum

Lors qu’elle est expiré, simplement en prendre une nouvelle.

Suite à l’obtention de la clé d’accès, utilisé celle-ci

1. Ajoutez le comme paramètre de la requête au nom de « access_token »

Exemple :

1. Connectez-vous à l’application de gestion PHPReaction
2. Aller à votre profil d’utilisateur
   • Le lien du profil se trouve sur votre nomme d’utilisateur dans le coin supérieur droit (https://xxx.phpreaction.com/profile/)
3. Cliquer sur « Générer une clé d’accès » / « generateAccessToken »
   • (Comme toutes fonctionnalité du système, il est possible que vous n’ayez pas les droits requis)
4. Vous devriez alors voir les informations d’autentification temporaire : « accessToken » et « accessTokenExpireAt »

1. Demander les credentials OAuth de client OAuth2 (client_id // client_secret) auprès de votre administrateur PHPReaction
2. Obtenir les identifiants (Username // Password) PHPReaction de votre utilisateur
3. Envoyer une requête à l’url d’authorization (/oauth/v2/token) afin de recevoir un « access_token »

Exemple :

4. Il est possible d’obtenir une réponse de non-autorisation

Vous n’utilisez simplement pas la bonne clé ou quelle n’est pas inscrite parfaitement.

Par la liste des ressources vous trouverez :

• l’ensemble des entités accessible par l’API
• Chacune des façons possible des l’appeler « Call »
  • Lecture : GET
  • Ajouter : POST
  • Modifier : PUT
  • Effacer : DELETE
• La structure descriptive / informations des propriétés dans la section « Models »

Si vous ne trouvez par ce que vous rechercher, il est possible que votre utilisateur ne soit pas autorisé au niveau de ses droits d’accès.

Pour accèder la à liste vous devez utiliser votre clé d’accès / « Access Token » / « access_token »

https://xxx.phpreaction.com/api/v3?access_token=ACCESS_TOKEN

Si vous n’avez pas de clé / « Access Token » simplement vous référer à la section « Authentification »

Objectif: Créer une nouvelle entité.

Description: Permet de créer une entité en passant les champs dans un format JSON.

HTTP Method: POST

Request URI:

Pattern: {baseUrl}/api/v3/{plurializedEntityName}

Exemple: xxx.phpreaction.com/api/v3/products

Sending:

Data type: JSON

Content: Toutes les propriétés requises + les propriétés désirées.
Prendre note que pour certaines entitées, qui contiennent des totaux, ceux-ci ne sont pas nécessaires à spécifier dans les propriétés.
Les propriétés de temps, comme « createdAt » et « updatedAt » ne sont pas à ajouter également, ils seront remplis automatiquement.
Pour toutes les propriétés qui sont des listes ou qui contiennent le mot « listing », ils ne sont pas obligatoires à remplir, pour la création.

Exemple:

Response status:

200: Resource created

Erreurs possibles:

Fix : Il y a un ID dans la requête. On ne peut pas forcé l’ID lors de la création d’une entitée.

Fix : Les valeurs de type Float et Double doivent être envoyé comme des String pour garder le niveau de précision. Ex: « amount »: « 5.5 »

Objectif: Modifier les informations d’une entité.

Description: Permet de modifier spécifiquement les informations fournies d’une entité par son ID en passant les champs dans un format JSON.

HTTP Method: PUT

Request URI:

Pattern: {baseUrl}/api/v3/{plurializedEntityName}/{id}

Exemple: xxx.phpreaction.com/api/v3/products/4

Sending:

Data type: JSON

Content: Properties to update

Exemple:

Response status:

200: Resource updated

Erreurs possibles:

Fix : Il n’y a pas de ID dans la requête. On ne peut pas ciblé l’ID pour la mise à jour d’une entitée.

Fix : Les valeurs de type Float et Double doivent être envoyées comme des String pour garder le niveau de précision. Ex: « amount »: « 5.5 »

Objectif: Supprimer l’entité.

Description: Permet de supprimer une entité en applicant le self-deletable s’il y a lieu.

HTTP Method: DELETE

Request URI:

Pattern: {baseUrl}/api/v3/{plurializedEntityName}/{id}

Exemple: phpc.phpreaction/api/v3/products/4

Response status:

200: Resource deleted