API do Adobe Acrobat Sign - Perguntas frequentes

1. Faça logon no Acrobat Sign.
2. Navegue até API do Acrobat Sign > Documentação da API REST.
3. Selecione a Versão 5.
4. No método post /users, use o código de solicitação mencionado no método
   UserCreationInfo
   {
   "email": "email@email.com",
   "firstName": "AA",
   "lastName": "AB",
   "password":"12******rte"
   }

As contas do Acrobat Sign que usam o Admin Console (Adobe One) para gerenciar seus direitos de usuários não podem usar a API do Acrobat Sign para criar usuários ou gerenciar usuários existentes.

O Adobe One Admin Console usa uma API diferente da API do Acrobat Sign. Consulte estes artigos para obter mais informações:

• https://helpx.adobe.com/br/enterprise/help/users.html
• https://developer.adobe.com/umapi/

Obter a ID do grupo:

Excluir grupo:

Gerar um documento temporário

Geração de um contrato usando o Documento temporário

Estas são as etapas para adicionar arquivos no parâmetro FileInfo:

Na chamada de POST /agreements, no parâmetro signatureflow, você pode passar o valor SENDER_SIGNS_FIRST ou SENDER_SIGNS_LAST para adicionar o remetente como primeiro ou último signatário respectivamente.

Veja a seguir um exemplo da chamada no formato JSON:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Para a função Enviar em nome de, ative o Compartilhamento de conta avançado da conta para que os usuários possam conceder permissões de envio a outros usuários enquanto compartilham a própria conta. Em Compartilhamento avançado, consulte Habilitação de compartilhamento de conta avançado.

Depois que Compartilhamento de usuário estiver habilitado, execute as etapas a seguir para Enviar em nome de:

Gerar um documento temporário:

Gerar um contrato usando o Documento temporário:

Estes são os parâmetros que você pode transmitir no código para definir a senha aberta:

Para criar um contrato usando a API com o estado “AUTHORING”, execute as seguintes etapas:

Acesse Post /agreements e crie o token de acesso com os escopos necessários.

Use o código de solicitação da seguinte maneira:

A v6 tem um conjunto de APIs de criação para criar um contrato. Na v5, o formFields é consumido diretamente na API POST /agreements. No entanto, o usuário da v6 pode criar um contrato no estado AUTHORING (state = AUTHORING) por meio da v6 de POST /agreements e usar PUT /agreements/ID/formFields a qualquer momento para adicionar campos de formulário aos documentos deste contrato.

Estas são as etapas:

Use POST /agreements para criar um contrato. Isso o envia para assinatura e retorna a agreementID na resposta ao cliente. Abaixo está o formato JSON para enviar o contrato usando o método de autenticação por telefone.

É possível mesclar os dados diretamente nos campos de formulário usando os seguintes métodos:

• Usar um modelo de biblioteca:
  
  se você estiver usando uma ID de modelo de biblioteca no parâmetro FileInfo, forneça o nome exato do campo e os dados associados na seção abaixo:

• Usar tags de texto em um documento carregado como um Documento temporário:
  
  se você fizer o upload de um documento que tenha tags de texto adicionadas a ele como um documento temporário, forneça o nome exato do campo e os dados associados na seção abaixo: 

Como enviar um contrato usando a API que tem valores pré-preenchidos nos campos de formulário específicos (mergefield)?

O pré-requisito desta chamada é primeiro concluir a etapa “Upload temporário” e obter uma “transientDocumentId” (usando: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) para usar aqui.

• Esta chamada inclui a seção “mergeFieldInfo”, na qual são fornecidos os valores padrão para campos de formulário específicos.
• Isso pré-preenche os dados vindos de outro sistema na chamada da API.
• Esses campos no contrato são editáveis ou somente leitura.

Pré-requisitos:

1. ID do documento temporário
2. Nomes de campos e seus respectivos valores

Exemplo de chamada de solicitação:

Ao executar o método “post /megaSigns/{megaSignId}/views”, um erro é exibido: “Requested view is not available for the resource in the current state”.

O erro é mostrado se o valor do parâmetro do nome fornecido for inválido no código de solicitação abaixo:

{
  "name": " "
}

Por exemplo, se o contrato do MegaSign já estiver “IN_PROCESS”, passar o valor como “AUTHORING” gera o erro mencionado. Verifique se o valor fornecido corresponde ao estado atual do contrato.

Ao executar o método “put /megaSigns/{megaSignId}/state”, um erro é exibido: “No value provided for MegaSign cancellation info”.

O erro é causado quando o código de solicitação não tem o parâmetro: 

"megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

Em vez de usar o “Esquema mínimo”, clique em “Completar esquema modelo” e forneça o código de solicitação completo para executar a chamada da API. 

Para alterar o estado do contrato do MegaSign, use put /megaSigns/{megaSignId}/state e execute as seguintes etapas:

1. Vá para a Documentação da API REST v6 e selecione o método
   put /megaSigns/{megaSignId}/state.
2. Forneça o valor de Authorization e também If-Match e a megasignID.
   • Para recuperar a megasignID, use get /megaSigns
   • Para recuperar If-Match, use get /megaSigns/{megaSignId} e, no cabeçalho, localize “Etag”
3. {
     "state": "CANCELED",
     "megaSignCancellationInfo": {
      "comment": "cancel",
      "notifyOthers": false
     }
   } 

Para registrar um webhook com êxito, o URL do webhook responde a essa solicitação de verificação com um código de resposta 2XX e, além disso, pode enviar o valor da mesma ID de cliente de uma das duas maneiras a seguir:

1. Em um cabeçalho de resposta X-AdobeSign-ClientId. É o mesmo cabeçalho transmitido na solicitação e que deve ser repetido na resposta.
2. No corpo da resposta JSON, com a chave de X-AdobeSign-ClientId e seu valor sendo a mesma ID de cliente enviada na solicitação.

O Acrobat Sign recebe a resposta 2xx com X-AdobeSign-ClientId. O usuário pode verificar se está configurado corretamente no webhook ou não.

O URL do webhook não está respondendo conforme esperado. Para cada notificação Post enviada pelo Acrobat Sign, o URL responde com o código do status 2XX e retransmite a ID de cliente enviada nos cabeçalhos de solicitação (X-AdobeSign-ClientId) para os cabeçalhos de resposta. 

Para obter informações completas, consulte o seguinte link:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

Quando o URL não cumpre este protocolo, o Acrobat Sign considera que ele não aceitou a solicitação e tenta reagendar de acordo com a política confiável.

Se o webhook não responder e o tempo máximo de repetição ou o intervalo máximo de repetição for excedido, o webhook será desativado.

  As postagens no Twitter™ e no Facebook não são cobertas pelos termos da licença Creative Co

Para alterar o documento já enviado para assinatura, use o método PUT /agreements/{agreementId}, com o qual você pode atualizar um contrato existente. Forneça a ID temporária junto com a ID do contrato no seguinte código de solicitação:

Estas são as instruções para atualizar o estado de “AUTHORING” para “IN_PROCESS” usando Put /agreements/{agreementId}/state:

Não.

Não há método que faz o upload de uma cópia assinada na API REST atual.

O remetente deve fazer upload da cópia assinada na página Gerenciar.

DELETE /agreements/ID era usado para ocultar um contrato na página de gerenciamento.

A Adobe tem uma nova API PUT /agreements/ID/me/visibility para controlar a visibilidade de um contrato (em GET /agreements). Além da funcionalidade fornecida por DELETE /agreements/ID, o novo endpoint de visibilidade também permite que um usuário reverta a operação “ocultar”, ou seja, torne o contrato visível novamente. 

Você também pode seguir as etapas detalhadas abaixo:

1. Acesse o método get /agreements e recupere a ID do contrato.
2. Clique em put /agreements/{agreementId}/me/visibility e forneça a solicitação abaixo como amostra:
   {
     "visibility": "HIDE"
   }
   A ID do contrato fica oculta somente em get /libraryDocuments, no entanto, ela ainda estará visível na interface da guia Gerenciar.

Você obtém a seguinte resposta se a operação DELETE/agreements não estiver ativada:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "The operation requires some account settings to be enabled. Entre em contato com a equipe do Acrobat Sign para habilitar as configurações.”

Como baixar o documento Assinado junto com o relatório de auditoria e o documento de suporte por meio da API REST do Acrobat Sign em vez de fazer uma chamada separada para baixar o relatório de auditoria usando o seguinte método.

GET /agreements/{agreementId}/auditTrail

Para fazer o download de documentos em massa, somente a ferramenta de exportação de documentos está disponível e, com a API, você pode fazer o download de documentos apenas um por um. Este é o método da API para fazer a mesma coisa:

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument

A Adobe tem um novo PUT /libraryDocuments/ID/me/visibility na API para controlar a visibilidade de um contrato (em GET/agreements). Além da funcionalidade fornecida por DELETE /agreements/ID, o novo ponto de acesso de visibilidade também permite que um usuário reverta a operação “ocultar”, ou seja, torne o contrato visível novamente.

Você pode seguir as etapas detalhadas abaixo:

1. Acesse o método get /libraryDocuments e recupere a ID do contrato.
2. Clique em put /libraryDocuments/{libraryDocumentId}/me/visibility e forneça a solicitação abaixo como amostra:
   {
     "visibility": "HIDE"
   }
   A ID da biblioteca fica oculta somente em get /libraryDocuments, no entanto, ela ainda estará visível na interface da guia Gerenciar.

Gerar uma libraryDocumentID

Excluir Modelos de biblioteca