Un lien externe est utilisé pour donner un accès aux données de l’API en lecture. Il permet aussi de communiquer via des Webhook afin de notifier d'évènements sur une plate-forme tierce.
Un lien externe doit contenir au minimum les informations suivantes :
Un code unique (Code)
Un nom décrivant l’API (Name)
Une clé auto-générée pour communiquer au travers des Webhook (WebhookKey)
Un type d’authentification pour les appels à l’API externe (AuthorizationType)
Basic
Clé d’api
L’adresse de l’api tierce pour la récupération des données (BaseUrl)
Un namespace correspondant au projet dans lequel le mapping entre les tables externes et interne est effectué (Namespace)
L’id et le code d’un journal comptable existant afin de définir le type de document à générer et la numérotation à suivre. (AccountingBookId & AccountingBookCode)
L’Id de la société facturante (BillCompanyId)
Certaines données peuvent également être ajoutée mais son optionnelles
L’id du client Prestashop si celui-ci doit être supplanté à celui des commandes (PrestaShopCustomerId)
Un Username et un Password (UserName & Password) si nécessaire pour communiquer avec l’API externe.
Une clé externe si l’API doit émettre elle aussi des notifications avec une plateforme externe