VocĂȘ estĂĄ aqui:
SequĂȘncia de API do Salesforce Contracts de amostra
Aqui estĂĄ uma sequĂȘncia de amostra de chamadas Ă API do Salesforce Contracts, que abrange um caminho ideal para um ciclo de vida de contrato de ponta a ponta. O ciclo de vida começa quando vocĂȘ cria um contrato e o contrato estĂĄ no estado de rascunho atĂ© a ativação do contrato.
| SequĂȘncia de API | CenĂĄrio | Tipo de mĂ©todo | Caminho da API | Descrição |
|---|---|---|---|---|
| 1 | Criar contrato | POST | <your domain URL>/services/data/{API version}/connect/clm/contract | Para criar um contrato a partir de oportunidade, cotação, pedido ou qualquer outro objeto padrão ou personalizado. Depois que um contrato é criado, ele estå no status de rascunho. corpo da solicitação: Se o tipo de configuração Gerar documento automaticamente na criação de contrato estiver definido como true, o aplicativo gerarå automaticamente uma versão do documento de contrato quando um contrato for criado. |
| 2 | Obter modelos de documentos | GET | <your domain URL>/services/data/{API version}/connect/clm/document-template?usageType=Contract_LifeCycle_Management&isActive=true&type=MicrosoftWord | Lista todos os modelos de documento ativos. Por padrão, os modelos que cumprem estes critérios são listados: Tipo = "Microsoftword", UsageType = "Contract_Lifecycle_Management", IsActive = verdadeiro Para obter informaçÔes sobre filtragem personalizada, consulte Usar filtragem de modelo de documento personalizado para Salesforce Contracts. |
| 3 | Gerar documento de contrato | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version | Para gerar uma nova versão do documento de contrato. O status do contrato deve estar no estado de rascunho para gerar uma nova versão do documento de contrato. corpo da solicitação: |
| 4 | Check-in | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/checkin | Para verificar a versão mais recente do documento de contrato que esteja inativa e bloqueada.Nota: Somente o usuårio que gerou o documento pode realizar a verificação de entrada. |
| 5 | Bloquear | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/lock | Para bloquear a versĂŁo atual do documento de contrato. VocĂȘ sĂł pode bloquear uma versĂŁo do documento de contrato quando o contrato estiver em um estado de rascunho e a versĂŁo do documento de contrato estiver ativa ou marcada. |
| 6 | Desbloquear | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/${contract document version ID}/unlock | Para desbloquear a versĂŁo atual do documento de contrato. Somente o usuĂĄrio que bloqueou a versĂŁo do documento de contrato ou um administrador do sistema pode desbloquear uma versĂŁo bloqueada do documento de contrato. |
| 7 | Check-out Gerar | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract-document-version/{$contract document version id}/Checkout | Para gerar uma nova versĂŁo do documento de contrato usando o mesmo modelo ou um modelo diferente, use a ação de geração de checkout. corpo da solicitação: ApĂłs o checkout, vocĂȘ deve executar a API de check-in. |
| 8 | Enviar para aprovação (Executar ação) | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | Para chamar o envio para ação de aprovação usando a API Executar ação. O ponto de extremidade permanece o mesmo; no entanto, cada API tem parùmetros de solicitação diferentes. O Processo de aprovação deve ser configurado. |
| 9 | Aprovar | N/A | N/A | Esta é uma API genérica do Salesforce Approval. Para obter mais informaçÔes, consulte https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_process_approvals_approve.htm. |
| 10 | Obter documentos para eSign com contrato | GET | <your domain URL>/services/data/{API version}/connect/e-sign/documents?sourceObjectId=${contractId} | Para visualizar a lista de documentos associados a um contrato que vocĂȘ deseja enviar para assinatura eletrĂŽnica. Os detalhes do documento sĂŁo obrigatĂłrios para enviar para assinatura eletrĂŽnica. VocĂȘ pode personalizar a lista de documentos usando uma classe do Apex personalizada. Os detalhes da classe Apex devem ser adicionados na Configuração de assinatura eletrĂŽnica. |
| 11 | Obter destinatĂĄrios | GET | <your domain URL>/services/data/{API version}/connect/e-sign/recipients?recipientSelector=ESignContactList&sourceObjectId={$contractId} | Para exibir uma lista de destinatĂĄrios do documento. Os detalhes do destinatĂĄrio sĂŁo obrigatĂłrios para enviar para assinatura eletrĂŽnica. VocĂȘ pode personalizar a lista de destinatĂĄrios usando uma classe do Apex personalizada. Os detalhes da classe Apex devem ser adicionados na Configuração de assinatura eletrĂŽnica. |
| 12 | ConfiguraçÔes Obter notificação | GET | <your domain URL>/services/data/{API version}/connect/e-sign/notification-settings?sourceObjectId={$contractId} | Para exibir as configuraçÔes de lembrete e notificação de expiração.Nota: Os detalhes da notificação são obrigatórios para enviar para assinatura eletrÎnica. |
| 13 | Obter papéis de signatårio | GET | <your domain URL>/services/data/{API version}/connect/e-sign/signer-roles | Para visualizar a lista de assinantes que assinam e adicionam dados a campos de formulårio nos documentos no envelope. Os detalhes do signatårio são obrigatórios para enviar para assinatura eletrÎnica. |
| 14 | Enviar para sinal eletrĂŽnico (Executar ação) | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | Para habilitar uma nova transação do DocuSign usando a API Enviar envelope. A API de ação deve cobrir os seguintes parĂąmetros: Corpo da solicitação de amostra. VocĂȘ deve converter detalhes JSON em String e adicionĂĄ-la no corpo da solicitação acima. actionData Ă© um JSON estruturado contendo documento, receita, papel de signatĂĄrio e configuraçÔes de notificação. |
| 15 | Atualizar status do envelope | PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | Para enviar uma solicitação ad hoc ao DocuSign para atualizar o status do envelope. Depois que o signatĂĄrio tiver assinado o documento, vocĂȘ poderĂĄ chamar a API Atualizar envelope. |
| 16 | Ativar contrato (Executar ação) |
PATCH | <your domain URL>/services/data/{API version}/connect/clm/contract/${contractid} | Para ativar o contrato. Use a API para ativar o contrato. |
| 17 | Encerrar contrato | PATCH | <detalhes da sua organização>/services/data/{API version}/connect/clm/contract/${contractid} | Para encerrar o contrato. |
APIs adicionais
| Cenårio | Tipo de método | Caminho da API | Descrição |
|---|---|---|---|
| Obter lista de versĂ”es de documentos de contrato | GET | <your domain URL>/services/data/{API version}/connect/clm/contract/<contractid>/contract-document-version | Para visualizar a lista de versĂ”es do documento de contrato que jĂĄ estĂŁo disponĂveis no contrato. |
| Obter a versĂŁo do documento SpecificContract | GET | <your domain URL>/services/data/{API version}/connect/clm/contract/{ContractId}/contract-document-version?contractDocumentVersionId={ContractDocumentVersionId} | Para visualizar uma versĂŁo especĂfica do documento de contrato que jĂĄ esteja disponĂvel no contrato. |
