Loading
Voorbeeld van API-sequentie Salesforce Contracts

Voorbeeld van API-sequentie Salesforce Contracts

Hier is een voorbeeld van een reeks API-aanroepen van Salesforce Contracts, die een optimaal traject bestrijkt voor een end-to-end contractlevenscyclus. De levenscyclus begint wanneer u een contract maakt en het contract de conceptstatus voor contractactivering heeft.

Voorbeeldreeks van API-aanroepen van Salesforce Contracts.

API-volgorde Scenario Type methode API-pad Beschrijving
1 Contract maken POST <uw domein-URL>/services/data/{API-versie}/connect/clm/contract

Een contract maken op basis van een opportunity, offerte, order of elk ander standaard- of aangepast object. Nadat een contract is gemaakt, heeft het de conceptstatus.

hoofdtekst verzoek:

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

Als het configuratietype Automatisch document genereren bij maken van contract is ingesteld op true (waar), genereert de toepassing automatisch een contractdocumentversie wanneer een contract wordt gemaakt.

2 Documentsjablonen ophalen GET <uwdomein-URL>/services/data/{API-versie}/connect/clm/document-sjabloon?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord

Vermeldt alle actieve documentsjablonen. Standaard worden de sjablonen vermeld die aan deze criteria voldoen:

Type = ‘Microsoftwoord’,

UsageType = 'Contract_Lifecycle_Management',

IsActive = true (waar)

Zie Filteren van aangepaste documentsjablonen gebruiken voor Salesforce Contracts voor informatie over aangepast filteren.

3 Contractdocument genereren PATCH <uw domein-URL>/services/data/{API-versie}/connect/clm/contract/{ContractId}/contract-document-versie

Een nieuwe contractdocumentversie genereren. De contractstatus moet de conceptstatus hebben om een nieuwe versie van het contractdocument te genereren.

hoofdtekst verzoek:

{
    "templateId":"<DocumentTemplateId>"
}
4 Inchecken PATCH <uwdomein-URL>/services/data/{API-versie}/connect/clm/contract-document-versie/${contract-document-versie-ID}/checkin Als u de nieuwste versie van het contractdocument wilt inchecken die zowel inactief als vergrendeld is.Opmerking: Alleen de gebruiker die het document heeft gegenereerd, kan inchecken uitvoeren.
5 Vergrendelen PATCH <uwdomein-URL>/services/data/{API-versie}/connect/clm/contract-document-versie/${contract-document-versie-ID}/lock De huidige versie van het contractdocument vergrendelen. U kunt een contractdocumentversie alleen vergrendelen wanneer het contract een conceptstatus heeft en de contractdocumentversie actief of ingecheckt is.
6 Ontgrendelen PATCH <uwdomein-URL>/services/data/{API-versie}/connect/clm/contract-document-versie/${contract-document-versie-ID}/unlock De huidige versie van het contractdocument ontgrendelen. Alleen de gebruiker die de contractdocumentversie heeft vergrendeld of een systeembeheerder kan een vergrendelde contractdocumentversie ontgrendelen.
7 Uitchecken Genereren PATCH <uwdomein-URL>/services/data/{API-versie}/connect/clm/contract-document-versie/{$contract-document-versie-id}/Checkout

Als u een nieuwe contractdocumentversie wilt genereren met behulp van dezelfde of een andere sjabloon met behulp van actie voor genereren bij uitchecken.

hoofdtekst verzoek:

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

Na Uitchecken moet u de Incheck-API uitvoeren.

8 Indienen voor goedkeuring (actie uitvoeren) PATCH <uw domein-URL>/services/data/{API-versie}/connect/clm/contract/${contractid}

De actie Indienen voor goedkeuring aanroepen met behulp van de API Actie uitvoeren. Het eindpunt blijft hetzelfde, maar elke API heeft verschillende verzoekparameters.

{
    "actionApiName" : "submitForApproval"
}

Goedkeuringsproces moet worden geconfigureerd.

9 Goedkeuren N.v.t. N.v.t.

Dit is een generieke Salesforce Approval API. Zie https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm voor meer informatie.

10 Documenten ophalen voor eSign met contract GET <uwdomein-URL>/services/data/{API-versie}/connect/e-sign/documents?sourceObjectId=${contractId}

De lijst weergeven van documenten die zijn gekoppeld aan een contract dat u wilt verzenden voor elektronische handtekening.

De documentdetails zijn verplicht om te verzenden voor elektronische handtekening. U kunt de documentenlijst aanpassen met behulp van een aangepaste Apex klasse. De details van de Apex klasse moeten worden toegevoegd in de configuratie voor elektronische handtekeningen.

11 Ontvangers ophalen GET <uwdomein-URL>/services/data/{API-versie}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId}

Een lijst van documentontvangers weergeven.

De details van de ontvanger zijn verplicht om te verzenden voor elektronische handtekening. U kunt de lijst van ontvangers aanpassen met behulp van een aangepaste Apex klasse. De details van de Apex klasse moeten worden toegevoegd in de configuratie voor elektronische handtekeningen.

12 Instellingen voor Kennisgeving ophalen GET <uwdomein-URL>/services/data/{API-versie}/connect/e-sign/notification-settings?sourceObjectId={$contractId} Instellingen voor herinneringen en vervalkennisgevingen weergeven.Opmerking: De details van de kennisgeving zijn verplicht om te verzenden voor elektronische handtekening.
13 Ondertekenaarsrollen ophalen GET <uw domein-URL>/services/data/{API-versie}/connect/e-sign/signer-roles

De lijst weergeven van ondertekenaars die formuliervelden ondertekenen en toevoegen aan de documenten in de envelop.

De details van de ondertekenaar zijn verplicht om te verzenden voor elektronische handtekening.

14 Verzenden voor elektronische ondertekening (actie uitvoeren) PATCH <uw domein-URL>/services/data/{API-versie}/connect/clm/contract/${contractid}

Een nieuwe DocuSign-transactie inschakelen met behulp van de Envelop verzenden-API.

De actie-API moet de volgende parameters dekken:

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

Voorbeeld van hoofdtekst van verzoek. U moet JSON-details converteren naar Tekenreeks en deze toevoegen aan de hoofdtekst van het bovenstaande verzoek.

{
    "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 is een tekenreeks-JSON met daarin instellingen voor document, receptint, ondertekenaarsrol en kennisgeving.

15 Envelopstatus bijwerken PATCH <uw domein-URL>/services/data/{API-versie}/connect/clm/contract/${contractid}

Een ad-hocverzoek verzenden naar DocuSign om de envelopstatus bij te werken. Zodra de ondertekenaar het document heeft ondertekend, kunt u de API Envelop bijwerken aanroepen.

{
  "actionApiName": "updateEnvelopeStatus"
}
16

Contract activeren (actie uitvoeren)

PATCH <uw domein-URL>/services/data/{API-versie}/connect/clm/contract/${contractid}

Het contract activeren.

Gebruik de API om het contract te activeren.

{
    "actionApiName" : "activateContract"
}
17 Contract beëindigen PATCH <details van uw organisatie>/services/data/{API-versie}/connect/clm/contract/${contractid}

Het contract beëindigen.

{
    "actionApiName" : "terminateContract"
}

Aanvullende API's

Scenario Type methode API-pad Beschrijving
Lijst van contractdocumentversies ophalen GET <uw domein-URL>/services/data/{API-versie}/connect/clm/contract/<contractid>/contract-document-versie Als u de lijst wilt bekijken van de contractdocumentversie die al beschikbaar is in het contract.
SpecificContract-documentversie ophalen GET <uwdomein-URL>/services/data/{API-versie}/connect/clm/contract/{ContractId}/contract-document-versie?contractDocumentVersionId={ContractDocumentVersionId} Een specifieke versie van het contractdocument weergeven, die al beschikbaar is in het contract.
 
Wordt geladen
Salesforce Help | Article