Utilisation API V4 PHPReaction

• Introduction
• PHPR ERP API V3
• Technologie
• Connexion
• Authentification avec jeton
• Utilisations
  • Documentation Endpoints
  • Status
  • URI
  • Champs requis
  • Champs read-only
  • Formats des dates
  • Metadata

PHPR ERP API V3 

URL : https://phpreaction.com/amelioration-continue/api-phpr-v3/

Technologie

API-Platform: https://api-platform.com/docs/

Connexion

Recevoir votre jeton

Pour la connexion, utiliser le endpoint suivant en remplaçant “{username}” par votre nom d’utilisateur et  “{password}” par votre mot de passe:

https://demo-ecs.phpreaction.com/authentication/open-api/v3/token/{username}/{password}

Il est aussi possible de le faire par l’interface Swagger dans l’onglet “Authentication” en entrant les champs tel qu’indiqué.

Si les informations entrées sont correctes, un jeton sera retourné. Gardez ce jeton, il est valide pendant 1 heure.

Authentification avec jeton

Une fois le jeton acquis, appuyez sur le bouton “Authorize” dans le coin supérieur droit de la page.

Une fenêtre va ouvrir et demander d’entrer une clé. Il s’agit du jeton précédé de : “Bearer ”.
Exemple 

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE3MTUwMTc4MDEsImV4cCI6MTcxNTAyMTQwMSwicm9sZXMiOlt7fSx7fV0sInVzZXJuYW1lIjoiU0pBWSIsInVzZXIiOnsiaWQiOjMsInNsdWciOiJjMmU2ZmNhZi1jNWZhLTRkNWYtYTExNC04NDkxMDE3Y2VjNzQiLCJ1c2VybmFtZSI6IlNKQVkiLCJlbWFpbCI6IlNKQVlAcGhwci5jYSIsImRlZmF1bHRDb3Jwb3JhdGlvbiI6MX0sInRlbmFudCI6ImRlbW8tZWNzIiwibG9jYWxlIjoiZW5fQ0EiLCJhcHBfbmFtZSI6IlBIUFJlYWN0aW9uIn0.aLJRA3_kRE4iTefhvhSCr92T55lZQ_vTavtJyCgWh5JtCMHrSIxkdnS93dSfAoBNA8785femsBPIsaILNJoD_NaZYDLdrht8E8b6R79UjWMmZ_R_82twcrAaGlhh57P89eap-emwGmJn0OHqEEUP9PYraEIbWacJzxRib2hpaPW8cWmVI4_mvOKH2lxZ32Wh6Byfs_6ZUBWCx-crrk88kqnGVa6iZb4DXYIJ3OA1faRjsEt1JF-ESpw66DaY21DPMCO4EOEm82jNejb2T1w9zld9MoMXLG7vuTdAQ9WXbmcyyurkTU3C79iiRD5dWDHpAh5q5k4XhFGal4_74Vtc4Jg1M1XRsmshJ3uZUAGh46myGlDlVCYtZjLDenli_72KjIIYALSZgCRaHiolj4hc6t28EhInTSfVkYGtuxbQEFJZza83J0eWk1vD6ZhVGfFlNsrBta21V9H4gdK83f0fQ-KepDClHjAeZ_PN19j9A9PKf2MgwIcXu_YjrWByLUXDJRfDzbVyQyXJ1_NWRdeKW-GPt8dpbI27CGaFEz-p41OD4CFU3EXmi3qQdzsFk3MjvzYQ_hDOD_BGD4soWWlqHoEiUrLbPHF37J40vbdhnFWs3pA4MpWmACpUfFytXRmPaaYRubQmhPB__u35wTiQztdvtYlshjIhmkWlTX0vZK8

Une fois la clé entrée, appuyer sur “Authorize”. La clé est maintenant autorisée et l’utilisation de l’API peut se faire.

Une fois la clé entrée, appuyer sur “Authorize”. La clé est maintenant autorisée et l’utilisation de l’API peut se faire.

Documentation Endpoints

Utilisation de l’interface Swagger

URL : https://demo-ecs.phpreaction.com/open-api/v3

Status

URL : https://demo-ecs.phpreaction.com/open-api/v3/status

URI

URL : https://api-platform.com/docs/core/subresources/

Certaines ressources de l’API utilisent des URI afin de faire un lien à d’autres éléments. Par exemple, lors de la création d’un employé, une personne doit être spécifié. Lors de la requête à l’API pour la création, un URI devra être utilisé pour pointer vers la ressource de la personne.

Ex: nouvel employé qui utilise la personne avec le ID 18

{
  person: /open-api/v3/person/18
}

Metadata

Certains endpoints ont des sections metadata. Ces sections sont utilisés pour la génération de formulaire et autres informations concernant les sections.

Champs requis

Afin de savoir quels champs sont requis pour une requête, rendez vous dans la section “Schemas” au bas de la page.

Pour chacune des entrées, une liste des champs est affichée avec le type associé incluant parfois s’ils sont nullables, s’ils ont une valeur par défaut et certains même avec exemple. Les champs requis sont dotés d’une étoile rouge.

Champs read-only

Certains champs sont automatiquement mis à jour et ne devraient pas être modifiés manuellement.

Ces champs incluent:

• CreatedAt
• DeletedAt

Formats des dates

Les dates doivent être sous le format suivant:

• Date : 2024-12-30
• DateTime : 2024-12-30 23:59:59