Votre organisation peut utiliser l'API publique de Case IQ pour importer des données de vos systèmes tiers dans Case IQ en temps quasi réel. Notre API utilise un compte de service dans votre application pour créer et mettre à jour les enregistrements dans votre système Case IQ . Vous devez ajouter un compte de service pour utiliser notre API publique.

Pour ajouter un compte de service :

1. Accédez à l'onglet Accès dans les Paramètres.
2. Sélectionnez « Profil utilisateur » dans le menu déroulant de la page.
3. Cliquez sur le bouton Ajouter un compte de service pour charger le formulaire Nouveau compte de service.
4. Remplissez les champs suivants sur le formulaire Nouveau compte de service.
   1. Identifiant utilisateur : définissez un identifiant ou un nom d’utilisateur unique pour authentifier le compte de service.
   2. Rôle de l'utilisateur : sélectionnez le niveau d'accès du compte de service. Le rôle de l'utilisateur détermine les actions que l'API peut effectuer dans votre application.
      1. Par exemple, si le compte de service ne dispose pas des autorisations nécessaires pour consulter les participants, l'API ne pourra pas mettre à jour les participants dans le système. Consultez la section « Gérer un rôle utilisateur » pour plus d'informations sur l'ajout et la modification des rôles utilisateur.
   3. Prénom et nom : vous pouvez saisir un prénom et un nom pour le compte de service. Nous vous recommandons d’utiliser le nom de la personne qui gère l’intégration de l’API.
   4. Adresse électronique : vous pouvez saisir une adresse électronique pour recevoir des notifications lorsque les clés API du compte de service expireront bientôt. Cette adresse électronique ne sera pas utilisée pour authentifier le compte de service.
   5. Numéro de téléphone : vous pouvez saisir un numéro de téléphone pour le compte de service. Nous vous recommandons d’utiliser le numéro de téléphone de la personne qui gère l’intégration de l’API.
   6. Langue : définissez la langue de l’interface du compte de service. La langue par défaut est l’anglais.
   7. Signature : vous pouvez créer une signature électronique pour le compte de service. L’utilisateur pourra ajouter le texte de signature que vous avez défini lors de la rédaction d’un e-mail dans Case IQ (consultez la section « Modifier les paramètres du compte » sur la page de profil pour plus de détails sur la création de signatures).
5. Cliquez sur le bouton Enregistrer pour terminer la création du compte.

Lorsque vous enregistrez le compte de service, Case IQ génère deux clés API dans l'onglet « Identifiants API ». Utilisez ces clés pour autoriser l'accès au compte de service.

Modifier un compte de service

Si vous disposez de l'autorisation de modifier les comptes de service, suivez les étapes suivantes pour mettre à jour un compte de service :

1. Sur la page Profils utilisateur, cliquez sur la ligne du compte de service dans la grille .
2. Cliquez sur le bouton Modifier .
3. La page du compte de service est désormais en mode édition. Vous pouvez maintenant modifier les champs du compte.
4. Une fois vos modifications terminées, cliquez sur le bouton Enregistrer .

Activer ou désactiver un compte de service

Vous pouvez désactiver un compte de service actif ou réactiver un compte inactif à tout moment. L'API ne pourra pas se synchroniser avec Case IQ à partir d'un compte de service inactif. Toutefois, tous les enregistrements créés ou mis à jour via l'API resteront dans le système.

Pour désactiver un compte de service :

1. Sur la page du compte de service, cliquez sur Options (  ) bouton.
2. Sélectionnez l’option « Désactiver ».
3. Cliquez sur « Oui » dans la fenêtre de confirmation pour procéder à la désactivation du compte.

La page du compte de service affiche désormais la mention « Inactif » et une bannière d'avertissement. Pour réactiver le compte, cliquez sur le lien de la bannière d'avertissement ou sur l'option « Activer » du menu contextuel (bouton Options ).

Consulter l'historique d'un compte de service

L'onglet Historique de la page du compte de service affiche la liste de toutes les actions effectuées sur l' enregistrement du compte. Les actions réalisées par le compte de service sont enregistrées dans l'onglet Activité. La grille Historique ne peut pas être exportée car elle contient plusieurs types de données. La grille Historique comporte les colonnes suivantes :

• Utilisateur : identifie l’utilisateur qui a effectué l’ action .
• Action : décrit le type de tâche effectuée.
• Modifications : affiche les valeurs des champs qui ont été modifiées lors de l’ action , en détaillant la valeur d’origine (« de » dans la ligne Historique) et la valeur après la modification (« à »).
• Date : la date et l'heure auxquelles l' action s'est produite.
• Adresse IP source : l’adresse IP de l’appareil utilisé par la personne pour effectuer l’action.

Afficher les sessions d'un compte de service

Le système enregistre les informations de session à chaque fois qu'un compte de service accède à l'application, à des fins de sécurité. L'onglet « Sessions » de la page du compte de service affiche la liste des activités de connexion, notamment l'adresse IP d'origine de l'appel API, l'heure de connexion et l'identifiant de session.

Consulter l'activité d'un compte de service

Case IQ enregistre toutes les actions effectuées par un compte de service dans l'onglet Activité, ce qui vous permet de suivre l'ensemble des opérations réalisées par l'API dans l'application. La grille Activité comporte les colonnes suivantes :

• Action : décrit le type de tâche effectuée.
• Modifications : affiche les valeurs des champs qui ont été modifiées lors de l’action, en détaillant la valeur d’origine (« de » dans la ligne Activité) et la valeur après modification (« À »).
• Référence : si l'action n'a pas été effectuée sur le dossier lui-même, mais sur un formulaire ou un document associé à l'affaire, cette colonne fournit plus d'informations sur le dossier où l'action a été effectuée.
• Date : la date et l'heure auxquelles l'action s'est produite.
• Adresse IP source : l’adresse IP à partir de laquelle l’appel API a été effectué.
• Agent utilisateur : les détails du navigateur, le système d’exploitation et sa version, ainsi que le type d’appareil utilisé par la personne pour effectuer l’action.