Quable Apps

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

Les Quable Apps fournissent des fonctionnalités supplémentaires directement dans votre Quable PIM. Elles permettent à des parties externes ou à des partenaires d'accéder de manière sécurisée au contenu de votre PIM Quable afin de fournir une fonction ou un service à tous les contributeurs.

Administrateurs

La page Quable Apps est celle où vous pouvez trouver et gérer toutes les applications (personnalisées ou générique) installées sur votre PIM. Sur la page suivante, vous trouverez un tableau avec toutes vos applications installées, ainsi que leurs données.

28442844

Créer une connexion

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

168168

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

28472847
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 à utiliser en icône de la QuableApp.
URI de l'app externeSaisissez 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 application.
Vous pouvez aussi cliquer sur le fil d'ariane en haut de page pour revenir à la page Quable Apps sans enregistrer l'application.

Modification d'une application

Vous pouvez modifier une connexion en la sélectionnant dans la liste et en cliquant sur l'icône "Editer"

162162

Suppression d'une application

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

162162

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

456456

❗️

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 externe 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".

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 externe :

"quableInstanceName"
"userName"
"userId"
"userEmail"
Informations sur le traitementInformations sur le type de contenu à traiter :

"sourceAction"
"documentIds"
Instructions de rappelL'URL de l'API Quable à appeler en fin de traitement afin d'envoyer une notification à l'utilisateur - si désiré :

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

Réponse de l'application externe

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 externe

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.