Support pour l'API

Toutes les entités peuvent être modifiées à l'aide de l'API OneSpan Sign Embedded Integration for CRM. On peut accéder à l'API dans OneSpan Sign Embedded Integration for CRM par le biais du service d'organisation appelé organization.svc.

En naviguant sur Paramètres > Personnalisations > Ressources pour les développeurs, les intégrateurs peuvent utiliser l'API pour effectuer les opérations suivantes :

• Création, mise à jour et suppression des enregistrements de la Convention
• Création, mise à jour et suppression de nouveaux enregistrements d'étiquettes de signataires
• Création, mise à jour et suppression de nouveaux enregistrements d'étiquettes de texte
• Associer des conventions aux modèles
• Conventions d'association aux transactions
• Associer les étiquettes de signataires aux signataires dans une transaction ou un modèle
• Création, mise à jour et suppression des enregistrements de mappage de champs
• Activez ou désactivez les paramètres de préparation automatique pour une transaction ou un modèle
• Activer ou désactiver les paramètres d'insertion pour une transaction ou un modèle
• Activer ou désactiver les Conventions

Pour obtenir plus d'informations, consultez le site Web de l'API.

Cette section décrit les éléments suivants :

• Connexion à une organisation
• Création d'un enregistrement
• Mise à jour d'un enregistrement
• Suppression d'un enregistrement
• Associer un enregistrement d'entité à un autre

Connexion à une organisation

Description/Objectif	ServiceProxy : Fournit un canal WCF authentifié au service d'organisation
Paramètres	Uri : L'URI du service de l'organisation HomeRealmUri : Ce paramètre est défini à une valeur non nulle lorsqu'une deuxième instance de l'ADFS est configurée en tant que fournisseur d'identité de l'instance de l'ADFS à laquelle OneSpan Sign Embedded Integration for CRM a été configurée pour l'authentification des demandes. La valeur du paramètre est l'URI du point de terminaison des métadonnées WS-Trust de la deuxième instance ADFS. ClientCredentials : Les informations d'identification du client DeviceCredentials : Les informations d'identification du périphérique Windows Live ID.
Valeurs renvoyées	URI du service de l'organisation

Reportez-vous à l'extrait de code suivant pour la configuration de la connexion. Il se connecte à une organisation spécifique sur OneSpan Sign Embedded Integration for CRM.

Création d'un enregistrement

Description/Objectif	ServiceProxy .Create : Création d'un nouvel enregistrement
Paramètres	Entité : Une instance d'entité qui contient les propriétés à définir dans l'enregistrement nouvellement créé. Par ex., Compte, prospect, etc.
Valeurs renvoyées	GUID de l'enregistrement nouvellement créé

Pour créer un nouvel enregistrement d'entité, consultez l'extrait de code suivant. Les enregistrements peuvent être créés dans n'importe quelle entité de OneSpan Sign Embedded Integration for CRM.

Mise à jour d'un enregistrement

Description/Objectif	ServiceProxy .Update : Mise à jour d'une entité existante
Paramètres	Entité : Une instance d'entité qui contient les propriétés à définir dans l'enregistrement nouvellement créé. Par ex., Compte, prospect, etc.
Valeurs renvoyées

Pour mettre à jour la valeur d'un champ, consultez l'extrait de code suivant :

Suppression d'un enregistrement

Description/Objectif	ServiceProxy .Delete : Supprime une entité existante
Paramètres	Entité : Une instance d'entité qui contient les propriétés à définir dans l'enregistrement nouvellement créé. Par ex., Compte, prospect, etc. GUID : Le GUID de l'enregistrement à supprimer.
Valeurs renvoyées

Pour supprimer un enregistrement dans une entité, consultez l'extrait de code suivant :

Associer un enregistrement d'entité à un autre

Description/Objectif	ServiceProxy .Associate : Associe une entité existante à une autre
Paramètres	Entité : Une instance d'entité qui contient les propriétés à définir dans l'enregistrement nouvellement créé. Par ex., Compte, prospect, etc. GUID : Le GUID de l'enregistrement à supprimer. Relation : Le nom de la relation à utiliser pour créer le lien. EntityReferenceCollection : Une collection de références d'entités (à des enregistrements) à associer.
Valeurs renvoyées

Pour associer un enregistrement d'entité à un autre, consultez l'extrait de code suivant :