Loading
Exemple de séquence d'API Salesforce Contracts

Exemple de séquence d'API Salesforce Contracts

Voici un exemple de séquence d'appels d'API Salesforce Contracts, qui couvre un parcours optimal pour un cycle de vie de contrat de bout en bout. Le cycle de vie commence lorsque vous créez un contrat et que l'activation du contrat est à l'état brouillon.

Exemple de séquence d'appels d'API Salesforce Contracts.

Séquence d'API Scénario Type de méthode Chemin d'API Description
1 Créer un contrat POST <URL de votre domaine>/services/data/{version d'API}/connect/clm/contract

Pour créer un contrat à partir d'une opportunité, d'un devis, d'une commande ou de tout autre objet standard ou personnalisé. Une fois le contrat créé, il est à l'état brouillon.

corps de requête :

{
    "sourceObjectId":"{$SourceObjectId}",
   "templateName":"{$DocumentTemplateName}",
    "isAutoDocgenRequired":false
} 

Si le type de configuration Auto Generate Document On Contract Creation est défini sur true, l'application génère automatiquement une version de document de contrat lors de la création d'un contrat.

2 Obtenir des modèles de document GET <URL de votre domaine>/services/data/{API version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord

Répertorie tous les modèles de document actifs. Par défaut, les modèles qui remplissent les critères suivants sont répertoriés :

Type = 'Microsoftword',

UsageType = 'Contract_Lifecycle_Management',

IsActive = true

Pour plus d ' informations sur le filtrage personnalisé, voir Utilisation du filtrage personnalisé des modèles de document pour Salesforce Contracts.

3 Générer un document de contrat PATCH <URL de votre domaine>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version

Pour générer une nouvelle version de document de contrat. Le statut du contrat doit être à l'état brouillon pour générer une nouvelle version du document de contrat.

corps de requête :

{
    "templateId":"<DocumentTemplateId>"
}
4 Prendre contact PATCH <URL de votre domaine>/services/data/{API version}/connect/clm/contract-document-version/${ID de version du document contractuel}/checkin Pour vérifier la dernière version du document de contrat qui est à la fois inactive et verrouillée.Remarque : Seul l'utilisateur qui a généré le document peut effectuer l'enregistrement.
5 Verrou PATCH <URL de votre domaine>/services/data/{API version}/connect/clm/contract-document-version/${ID de version du document contractuel}/lock Pour verrouiller la version actuelle du document de contrat. Vous pouvez verrouiller une version de document de contrat uniquement lorsque le contrat est à l'état brouillon et que la version du document de contrat est active ou enregistrée.
6 Déverrouiller PATCH <URL de votre domaine>/services/data/{API version}/connect/clm/contract-document-version/${ID de version du document contractuel}/unlock Pour déverrouiller la version actuelle du document de contrat. Seul l'utilisateur qui a verrouillé la version du document de contrat ou un administrateur système peut déverrouiller une version verrouillée du document de contrat.
7 Check Out Générer PATCH <URL de votre domaine>/services/data/{API version}/connect/clm/contract-document-version/{$ID de version du document contract}/Checkout

Pour générer une nouvelle version de document de contrat en utilisant le même modèle ou un modèle différent en utilisant l'action Checkout generate.

corps de requête :

{
    "templateId":"{$templateId}"
} 

Après Check Out, vous devez exécuter l'API Check In.

8 Soumettre pour approbation (exécuter l'action) PATCH <URL de votre domaine>/services/data/{version API}/connect/clm/contract/${contractid}

Pour appeler l'action Soumettre pour approbation en utilisant l'API Exécuter l'action. Le point de terminaison reste le même. Cependant, chaque API a des paramètres de requête différents.

{
    "actionApiName" : "submitForApproval"
}

Le processus d'approbation doit être configuré.

9 Approuver n/a n/a

Il s'agit d'une API Salesforce Approval générique. Pour plus d'informations, consultez https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm.

10 Obtenir des documents pour eSign avec un contrat GET <URL de votre domaine>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId}

Pour afficher la liste des documents associés à un contrat que vous souhaitez envoyer pour signature électronique.

Les détails du document sont obligatoires pour envoyer la signature électronique. Vous pouvez personnaliser la liste des documents en utilisant une classe Apex personnalisée. Les détails de la classe Apex doivent être ajoutés à la Configuration de la signature électronique.

11 Obtenir des destinataires GET <URL de votre domaine>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId}

Pour afficher la liste des destinataires du document.

Les détails du destinataire sont obligatoires pour envoyer une signature électronique. Vous pouvez personnaliser la liste des destinataires en utilisant une classe Apex personnalisée. Les détails de la classe Apex doivent être ajoutés à la Configuration de la signature électronique.

12 Paramètres Obtenir une notification GET <URL de votre domaine>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} Pour afficher les paramètres de notification de rappel et d'expiration.Remarque : Les détails de notification sont obligatoires pour envoyer une signature électronique.
13 Obtenir des rôles de signataire GET <URL de votre domaine>/services/data/{version API}/connect/e-sign/signer-roles

Pour afficher la liste des signataires qui signent et ajoutent des données aux champs de formulaire des documents de l'enveloppe.

Les détails du signataire sont obligatoires pour envoyer la signature électronique.

14 Envoyer pour E-Sign (exécuter l'action) PATCH <URL de votre domaine>/services/data/{version API}/connect/clm/contract/${contractid}

Pour activer une nouvelle transaction DocuSign en utilisant l'API Envoyer une enveloppe.

L'API d'action doit couvrir les paramètres suivants :

{
  "actionApiName": "sendForESign",
  "actionData":
  {
  "requestBody": <Request Body for E-Signature>  }
}

Exemple de corps de requête. Vous devez convertir les détails JSON en Chaîne et les ajouter au corps de requête ci-dessus.

{
    "vendor": "Docusign",
    "emailSettings": {
        "emailSubject": "<EMail Subject>",
        "emailBody": "<EMail Body>"
    },
    "documents": [{
        "fileExtension": "<Ex:docx>",
        "name": "<File name to be sent for ESign EX:Test.docx>",
        "sourceId": "<Document Content Id of the file to be sent for ESign>",
        "sourceType": "Content",
        "documentId": "1"
    }],
    "recipients": {
        "signers": [{
            "name": "<Signer Name>",
            "email": "abc@example.com", 
            "recipientId": "1",
            "routingNumber": 1,
            "recipientType": "signer",
            "recipientLocale": "EN",
            "signerRole": 1,
            "routingOrder": 1
        }],
         "inPersonSigners": [{
            "name": "<Host Name>",
            "email": "xyz@example.com", 
            "recipientId": "2",
            "routingNumber": 2,
            "parentSignerName":"<Name of the In Person Signer>",
            "recipientType": "inPersonSigner",
            "recipientLocale": "EN",
            "signerRole": 2,
            "routingOrder": 2
        }],
         "carbonCopies": [{
            "name": "<Carbon Copy Recipient Name>",
            "email": "test@example.com", 
            "recipientId": "3",
            "routingNumber": 2,
            "recipientType": "carbonCopy",
            "recipientLocale": "EN",
            "routingOrder": 2
        }]
    },
    "notificationSettings": {
        "useAccountDefaults": false,
        "reminders": {
            "reminderFrequency": "1",
            "reminderDelay": "2",
            "reminderEnabled": false
        },
        "expirations": {
            "expireWarn": "1",
            "expireAfter": "5",
            "expireEnabled": false
        }
    }
}

actionData est un JSON stringifié contenant les paramètres de document, de recette, de rôle de signataire et de notification.

15 Mettre à jour le statut de l'enveloppe PATCH <URL de votre domaine>/services/data/{version API}/connect/clm/contract/${contractid}

Pour envoyer une requête ad hoc à DocuSign afin de mettre à jour le statut de l'enveloppe. Lorsque le signataire a signé le document, vous pouvez appeler l'API Mettre à jour l'enveloppe.

{
  "actionApiName": "updateEnvelopeStatus"
}
16

Activer le contrat (exécuter l'action)

PATCH <URL de votre domaine>/services/data/{version API}/connect/clm/contract/${contractid}

Pour activer le contrat.

Utilisez l'API pour activer le contrat.

{
    "actionApiName" : "activateContract"
}
17 Résilier le contrat PATCH <détails de votre organisation>/services/data/{version API}/connect/clm/contract/${contractid}

Pour résilier le contrat.

{
    "actionApiName" : "terminateContract"
}

API supplémentaires

Scénario Type de méthode Chemin d'API Description
Obtenir la liste des versions de document de contrat GET <URL de votre domaine>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version Pour afficher la liste des versions de document de contrat déjà disponibles dans le contrat.
Obtenir la version du document SpecificContract GET <URL de votre domaine>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} Pour afficher une version de document de contrat spécifique qui est déjà disponible dans le contrat.
 
Chargement
Salesforce Help | Article