Référence de script des connecteurs personnalisés

Chaque endpoint enregistrable exposé par le runtime de scripting du tenant, regroupé selon sa fonction et lié à une page dédiée lorsqu’elle existe.

Connecteurs personnalisés présente le modèle fournisseur-client et de mise à jour de Carte utilisé par la plupart des intégrations, ainsi que les globales approuvées disponibles pour chaque script (fetch, console, getSecret, entre autres). Cette page répertorie tous les autres points de terminaison enregistrables exposés par l’environnement d’exécution, y compris des hooks plus spécifiques qui n’ont pas de guide dédié ailleurs. Certains nécessitent un câblage supplémentaire — une étape de flux, une tâche planifiée, une entrée de fichier de configuration — et sont documentés sur la page indiquée dans le tableau ci-dessous. Les quatre qui ne nécessitent aucun câblage supplémentaire ont chacun leur propre page ici.

L’éditeur de configuration avancée génère la saisie semi-automatique et la documentation en ligne pour chaque point de terminaison enregistrable — ses paramètres et son type de retour — directement depuis l’environnement d’exécution. Il constitue la référence faisant autorité et toujours à jour pour la surface de script ; utilisez cette page pour découvrir ce qui existe.

Points de terminaison enregistrables

Chaque point de terminaison ci-dessous est enregistré de la même manière, depuis l’exportation par défaut d’un script :

export default function (context) {
  context.register('<clé d’enregistrement>', {
    // une ou plusieurs fonctions de gestionnaire
  });
}

Clé d’enregistrement	Fonction(s)	Nécessite un câblage supplémentaire	Documenté sur
runtime.scriptable.customerProvider.{scriptId}	Fill(entity)	Oui — une entrée customerProviders de type script dans la configuration du flux de processus	Connecteurs personnalisés
runtime.wallet.passUpdater	OnCarteCreating, OnCarteCreated, OnCarteUpdating, OnCarteUpdated, OnCarteInstalled, OnCarteUninstalled	Non	Connecteurs personnalisés, Hooks d’installation et de désinstallation de Carte
runtime.scriptable.customerPipelineElement.{scriptId}	CreateOrUpdate(entity)	Oui — utilisé comme étape de type script- dans un flux d’enregistrement client	Connecteurs personnalisés
runtime.scriptable.pushUpdates.{scriptId}	GetCartes()	Oui — une tâche planifiée faisant référence au nom du script	Connecteurs personnalisés
runtime.scriptable.emailEngine	SendEmail(recipient, template, data, cultures, buildEmail)	Oui — /server/emails.yml fournisseur défini sur script	Extensibilité d’EmailSender
runtime.scriptable.scriptableAccountValidator	Validate(account)	Non	Validation de compte
runtime.emailAccountChallenger.templateFinder	GetEmailTemplate(data, defaultTemplateName)	Non	Sélection du modèle de challenge par e-mail
runtime.wallet.linkUrlEnricher	Enrich(url, context)	Non	Enrichissement de l’URL du lien Wallet
runtime.import.updateCartes.rowTransformer	GetThroughput(fileName), Transform(row)	Non	Transformation des lignes de mise à jour groupée de Carte

Si aucun script n’enregistre un point de terminaison donné, le comportement par défaut de la plateforme s’applique et rien n’échoue. Si un script enregistre un point de terminaison mais omet une méthode qu’il doit implémenter, l’appel échoue lorsque cette méthode est atteinte. Si un fichier de script contient une erreur de syntaxe, aucun des points de terminaison de script de ce locataire ne se charge — pas seulement ceux du fichier défectueux. Et lorsque deux fichiers enregistrent la même clé, le dernier chargé l’emporte, silencieusement.

Connecteurs basés sur SOAP

Cegid Retail Y2 et UR placent leurs API SOAP derrière leur propre intercepteur de requêtes — extensions.cegid.y2.connectionInterceptor et extensions.cegid.ur.connectionInterceptor — utilisé pour inspecter ou modifier chaque appel sortant, généralement afin d’injecter un en-tête d’authentification depuis le magasin de secrets. Il est spécifique à ces deux connecteurs plutôt que d’être un hook disponible pour tout connecteur personnalisé ; il est donc documenté dans la propre référence de script de Cegid plutôt qu’ici.

FAQ

Cette page remplace-t-elle la saisie semi-automatique de l’éditeur de configuration avancée ?

Non. L’éditeur génère sa documentation directement depuis l’environnement d’exécution, elle reflète donc toujours exactement la version actuelle. Cette page est un index organisé destiné à être lu avant d’ouvrir l’éditeur, afin de rendre visibles les points de terminaison qu’il serait autrement facile de manquer.