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 {{Token}}
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.
Utilisations
Documentation Endpoints
Vous pouvez accéder à l’interface de Swagger à l’aide de l’URL suivant en remplacant « xxx » par votre entreprise (tenant):
https://xxx.phpreaction.com/open-api/v3/docs
Vous pouvez accéder au statut de l’API à l’aide de l’URL suivant en remplacant « xxx » par votre entreprise (tenant) :
https://xxx.phpreaction.com/open-api/v3/status
URI
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