Applications Tierce

Vous avez besoin d'une intégration spécifique ? Intégrez-la directement dans le PIM

Les Applications Tierce fournissent des fonctionnalités supplémentaires directement dans votre Quable PIM. Elles permettent à des parties externes ou à des partenaires d'accéder en toute sécurité au contenu de votre PIM Quable afin de fournir une fonction ou un service à tous les contributeurs.

Administrateurs

🚧

Prérequis

Vous devez avoir votre propre compte avec l'app tierce que vous voulez connecter.

La page Applications Tierce est l'administration où vous pouvez définir et gérer les connexions disponibles.
La page comprend une liste des connexions existantes, le cas échéant.

Créer une connexion

Pour ajouter une nouvelle connexion, cliquez sur le bouton Créer :

Un formulaire s'affiche pour définir la connexion et ses propriétés.

InformationDescription>
Nom d'affichageSaisissez un nom descriptif pour la connexion.
CodeSaisissez une valeur alphanumérique pour identifier la connexion.

Note : Cette valeur ne peut pas être modifiée après la création de la connexion.

DescriptionSaisissez du texte pour décrire le but de la connexion.
Type d'informationSpécifier le type d'information à envoyer :

  • Document - pour envoyer des informations sur le document.
    Vous devez ensuite sélectionner un Type de document

Font Awesome icôneSaisissez le nom d'une Icône Font Awesome à afficher pour l'app tierce.
URI de l'app tierceSaisissez l'URI de l'application qui doit être appelée par le PIM.
Type d'authentificationSélectionnez le type d'authentification à utiliser et saisissez la valeur dans la zone de saisie appropriée :

  • Token - une chaîne aléatoire de lettres et de chiffres.

  • Paramètre - corps de requête JSON.

Une fois que vous avez saisi toutes les informations, cliquez sur le bouton Appliquer pour enregistrer la nouvelle connexion ou sur le bouton Retour pour revenir à la page Applications Tierce sans enregistrer la connexion.

Modification d'une connexion

Vous pouvez modifier une connexion en la sélectionnant dans la liste et en cliquant sur le bouton Modifier.

Un formulaire s'affiche pour modifier la connexion et ses propriétés. Lorsque vous avez terminé vos modifications, cliquez sur le bouton :

  • le bouton Valider pour enregistrer vos modifications, ou
  • le bouton Retour pour revenir à la page Applications tierces sans enregistrer les modifications.

Suppression d'une connexion

Vous pouvez supprimer une connexion en la sélectionnant dans la liste de la page Applications tierces et en cliquant sur le bouton Supprimer.

Une boîte de dialogue s'affiche pour annuler ou confirmer la suppression.

❗️

Attention

Cette action est irréversible. Une fois qu'une connexion a été supprimée, elle ne peut pas être récupérée.

Intégrateurs

Appel de l'Application Tierce par Quable

🚧

Prérequis

Pour pouvoir connecter une Application Tierce, vous devez avoir des connaissances sur le mécanisme d'authentification, les en-têtes, les points de terminaison et les paramètres.

👍

Les communications avec les Applications Tierces sont basées sur les principes REST et suivent les directives RFC2119.

Quable PIM prend les informations que vous avez saisies lors de la création de la connexion et les utilise pour "communiquer" à l'API tierce.

Fonctionnement

Lorsqu'un utilisateur du PIM cliquera sur le bouton, un appel API sera fait sur l'API Quable PIM. L'API Quable va appeler en "back" l'URL fournie dans la connexion avec les paramètres demandés et attendra une réponse précise (cf plus bas).

Cette réponse comportera une URL et c'est celle-ci qui sera chargée dans la popin que l'utilisateur verra s'afficher.

Appel de l'URI fournie dans le back-office

L'API Quable effectue un appel POST à l'URI fournie en y ajoutant les paramètres fournies

curl --request POST \
  --url http://www.domain.tld/myInapp
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
...

Voici le détail :

Description

Request

Verbe / méthode HTTP confirmant que des informations sont envoyées dans le corps de requête:
POST

URL

L'adresse de la connexion

Headers

Identifie le format des informations envoyées :

Accept: application/json
Content-Type: application/json

Ensuite, vient le corps de la requête. Il comprend les informations à traiter et les instructions de réponse requises

"data": {
    "quableInstanceName": "my-instance",
    "userName": "johnDoe",
    "userEmail": "[email protected]",
    "userId": 153,
    "sourceAction": "document_page",
    "documentIds": [
        "001234",
        "A23979"
    ],
    "notificationCallback": {
        "url": "http://my-instance.quable.com/myservice",
        "token": "abc1defgh23ijkl4mnopq56urstuv78wxyz9",
        "method": "POST"
    }
}

Les données contiennent trois parties : Les informations d'identité, les informations de traitement, et les instructions de rappel.

En voici la répartition :

Description

Identité

Informations identifiant Quable PIM et l'utilisateur demandant accès à l'Application Tierce :

"quableInstanceName"
"userName"
"userId"
"userEmail"

Informations sur le traitement

Informations sur le type de contenu à traiter :

"sourceAction"
"documentIds"

Instructions de rappel

L'URL de l'API Quable à appeler en fin de traitement afin d'envoyer une notification à l'utilisateur - si désiré dans le fonctionnement de l'Application Tierce :

"notificationCallback.url"
"notificationCallback.token"
"notificationCallback.method"

Réponse de l'Application Tierce

L'application tierce reçoit un appel depuis l'API Quable avec les informations données dans la connexion et les données sur l'utilisateur et les objets à traiter.
Afin que le PIM puisse proposer le contenu de l'application tierce à l'utilisateur, cette dernière doit répondre avec une code HTTP 200 et un corp de requête comme ci-dessous.

  • Succès - 200:
{
  "url": "https://my-app.domain.tld/my-app-form",
  "err": 0,
}

Toute réponse autre qu'un code HTTP 200 et un body contenant la valeur "0" pour l'attribut "err" sera considérée comme une erreur et indiquée comme telle à l'utilisateur.

Gestion du contenu par l'application tierce

Si toutes les conditions sont réunies, l'URL fournie dans le corps de requête sera appelée dans la popin et c'est ensuite l'Application Tierce qui gère son contenu.


Did this page help you?