Assistance en ligne

4CE – Générer son jeton d'authentification pour les API

FAQ 5 minutes de lecture imprimer

4CE expose des API REST publiques lui permettant de communiquer et d’échanger avec n’importe quelle application. Celles-ci vous permettront de réaliser diverses actions sans passer par l’interface graphique de 4CE. Ces API peuvent être utilisées dans tout projet d’intégration avec un autre logiciel.

L’accès à ces API se fait de manière sécurisée au moyen d’un jeton d’authentification que vous devez paramétrer. Celui-ci possède un identifiant unique généré par le système (UUID) à sa création. Il est envoyé dans le header de la requête pour chacune des requêtes du client vers le serveur de ressources.

Attention : vous devez créer au moins un jeton dédié aux API 4CE.

  1. Dans l’onglet Administration, cliquez sur Tenants > Jetons d’authentification API.
  2. Cliquez sur le bouton Créer un jeton.

  1. Saisissez obligatoirement le nom du jeton.
  2. Renseignez éventuellement une description relative à son usage.
  3. Saisissez obligatoirement la période de validité du jeton (dates de début et de fin).
  4. Cliquez sur Enregistrer pour valider votre saisie.

4CE attribue un identifiant unique au jeton : c’est ce code qui est utilisé par la requête afin d’autoriser l’accès à l’API REST publique d’Unified. Cet identifiant doit rester confidentiel. Le jeton est ajouté à la liste existante

Définir les API auxquelles le jeton peut accéder.

Cette action est possible une fois que le jeton est créé. Vous pouvez définir les URL autorisées, en sachant qu’un jeton est associé à un ou plusieurs domaines.

  1. Dans l’onglet Administration, cliquez sur Tenants > Jetons d’authentification API.
  2. Sélectionnez, dans la liste, le jeton concerné
  3. Cliquez sur l’onglet Liste des URLs.

Vous devez à présent indiquer toutes les API 4CE auxquelles ce jeton d’authentification peut avoir accès :

attachment Pièces jointes rattachées aux dossiers
document Documents rattachés aux dossiers (uniquement les enregistrements des appels dans cette version)
interaction Echanges réalisés au cours d’un dossier
thread Gestion des dossiers 4CE
user Gestion des utilisateurs 4CE
  1. Cliquez sur Ajouter.
  2. Saisissez strictement en minuscules le nom de l’API à autoriser.
  3. Cliquez sur Enregistrer pour valider la saisie.

Répétez les étapes 1 à 3 pour chaque ressource à autorise.

Vous devez définir les url autorisées pour ce jeton en reproduisant les étapes 1 à 3, mais en saisissant l’url souhaitée à l’étape 2 (voir copie écran ci-dessous).

A noter : Vous pouvez avoir plusieurs jeton pour les API, si vous désirez les « spécialiser ».

Ces informations vous ont-elles aidé ?

Merci pour votre vote

Laurent

Voir ses articles