en English
X

Select Language

Powered by Google TranslateTranslate

We hope you will find the Google translation service helpful, but we don’t promise that Google’s translation will be accurate or complete. You should not rely on Google’s translation. English is the official language of our site.

en English
X

Select Language

Powered by Google TranslateTranslate

We hope you will find the Google translation service helpful, but we don’t promise that Google’s translation will be accurate or complete. You should not rely on Google’s translation. English is the official language of our site.

Assinatura remota de documentos com eSigner CSC API

Este guia mostrará como inscrever um pedido de certificado de assinatura de documento com SSL.com's eSigner serviço e usar a API Cloud Signature Consortium (CSC) para assinar digitalmente um hash de documento e um arquivo PDF. Você pode usar este guia com qualquer cURL or Postman. Recomendamos que os usuários do Postman instalem o aplicativo de desktop para trabalhar com os exemplos.

Os exemplos neste guia usam o ambiente eSigner de produção de SSL.com. Se você gostaria de experimentar a API CSC no ambiente de teste Sandbox de SSL.com antes de trabalhar com pedidos de certificados reais, leia Guia de integração para teste de assinatura remota com eSigner CSC API. Se quiser experimentar o eSigner Sandbox com uma conta de demonstração e certificado, leia Credenciais e certificados de demonstração do eSigner para credenciais e informações de configuração.

Para seguir essas instruções, você precisará de:

  • Um pedido de certificado de assinatura de documento validado. Por favor leia este tutorial para obter instruções completas sobre pedido e validação.
  • A ID do cliente (também conhecido como ID do aplicativo. Por favor, consulte este tutorial para obter instruções sobre como gerar essa credencial).

Inscreva-se no eSigner e configure a autenticação de dois fatores

  1. Antes de começar a usar a API CSC, você precisará se inscrever no eSigner. Navegue até o Pedidos em sua conta SSL.com e localize seu pedido.
    Localizar pedido
  2. Clique no pedido detalhes link.
    detalhes
  3. Crie e confirme um PIN de 4 dígitos e clique no botão criar PIN botão.
    Se você precisar redefinir seu PIN do eSigner, leia este tutorial.
    Criar PIN
  4. Um código QR aparecerá.
    Na próxima vez que você recarregar a página, o código QR não estará visível. Se você precisar visualizar ou redefinir seu código QR eSigner, leia este tutorial.
    QR Code
  5. Digitalize o código em um aplicativo de autenticação de dois fatores em seu dispositivo móvel, como Google Authenticator or Authy. O aplicativo fornecerá senhas de uso único (OTPs) para usar ao assinar. Cada OTP é válido por 30 segundos.
    OTP em Authy
Dica: Você pode usar o eSigner para compartilhar certificados de assinatura validados pela organização (OV) entre colegas de equipe. Por favor leia Compartilhamento de equipe para documentos eSigner e certificados de assinatura de código EV para obter instruções.

Instalar Postman e importar coleções de API

As instruções nesta seção são apenas para usuários do Postman. Se estiver usando cURL com a API CSC, você pode seguir para a próxima seção.

  1. Baixe e descompacte o Coleção CSC API Postman e Coleção Postman da Document Signing API.
    Coleções de carteiro
  2. Baixe e instale o Cliente Postman REST.
    Download do cliente Postman REST
  3. Inicie o Postman e, em seguida, crie uma nova conta do Postman ou entre em uma existente.
    Login do carteiro
  4. Clique na importação botão.
    Botão Importar
  5. Clique na Fazer upload de arquivos botão, navegue até os arquivos de coleção de API descompactados (csc-api-prod.postman_collection.json e document-signing-api-prod.postman_collection.json) e abri-los.
    Fazer upload de arquivos
  6. Clique na importação botão.
    Clique no botão importar
  7. As solicitações de API com as quais você trabalhará agora estão disponíveis no Coleções guia no lado esquerdo da janela do Postman.
    Pedidos de API

Recuperar token de acesso

A próxima etapa é recuperar um token de acesso de SSL.com. Você vai precisar do seu ID do cliente disponível, bem como o nome de usuário e a senha da sua conta SSL.com. Os tokens de acesso são válidos por uma hora após sua emissão.

Use as guias clicáveis ​​abaixo para escolher as instruções para Postman ou cURL:

Instruções do carteiroInstruções cURL
  1. Selecione uma solicitação de API da coleção CSC API.
    selecionar solicitação de API
  2. Selecione os Autorização Guia e selecione OAuth 2.0 de Tipo menu.
    Guia Autorização
  3. Insira as seguintes informações no formulário:
    • Prefixo do cabeçalho: Bearer
    • Nome do Token: SSLCOM CSC (ou qualquer outro nome fácil de lembrar de sua preferência)
    • Tipo de concessão: Authorization Code
    • URL de retorno de chamada: https://upload.esigner.com
    • Autorizar usando o navegador: não verificado
    • URL de autenticação: https://login.ssl.com/oauth2/authorize
    • URL do token de acesso: https://login.ssl.com/oauth2/token
    • ID do Cliente: [Seu ID de cliente]
    • Segredo do Cliente: [deixe em branco]
    • Escopo: service
    • Estado: [deixe em branco]
    • Autenticação de cliente: Send as Basic Auth header

    Quando terminar, clique no Obtenha um novo token de acesso botão.
    Obtenha um novo token de acesso

  4. Um formulário de login aparecerá. Digite seu nome de usuário e senha SSL.com e clique no botão Acesso de Membros botão.
    Login da conta
  5. Seu novo token de acesso deve aparecer no Postman. Selecione o texto do token de acesso, copie-o para a área de transferência e feche o Gerenciar tokens de acesso caixa de diálogo. Cole seu token de acesso em um editor de texto onde você possa acessá-lo facilmente. Cada token de acesso expirará após uma hora.
    Você também pode salvar seu token para reutilizá-lo em solicitações do Postman, mas descobrimos que é mais confiável copiar e colar o token diretamente em cada solicitação.
    token de acesso
  1. Use o seguinte comando para solicitar um token de acesso. Substitua os valores mostrados em MAIÚSCULAS pelos seus valores reais:
    curl --location --request POST "https://login.ssl.com/oauth2/token" \ --header "Content-Type: application / json" \ --data-raw "{\" client_id \ ": \ "YOUR-CLIENT-ID \", \ "grant_type \": \ "senha \", \ "username \": \ "YOUR-USERNAME \", \ "password \": \ "YOUR-PASSSWORD \"} "
  2. Você deve receber um objeto JSON contendo um token de acesso e um token de atualização. Copie o valor do token de acesso para colar em suas solicitações de API. Você não precisará do token de atualização para esses exemplos.
    Recuperar token de acesso

Assine um Hash

Agora que você tem um token de acesso, pode começar a fazer solicitações de API e criar assinaturas. Esta seção o conduzirá pelas cinco solicitações disponíveis na coleção Postman CSC, resultando na criação de uma assinatura digital a partir de um hash de documento.

Obtenha informações do CSC (opcional)

Instruções do carteiroInstruções cURL
  1. Você pode usar o Informações CSC solicitação para obter informações sobre o serviço de assinatura em nuvem SSL.com. Observe que, ao contrário das outras na coleção, esta solicitação não requer seu token de acesso. Para enviar a solicitação, selecione Informações CSC de API CSC coleção e clique no ENVIAR botão.
    Enviar pedido de informação CSC
  2. As informações sobre o serviço de assinatura em nuvem aparecerão em um objeto JSON no Postman's Resposta campo.
    Informações CSC
  1. Use o seguinte comando para obter informações sobre o serviço CSC API de SSL.com:
    curl --location --request POST "https://cs.ssl.com/csc/v0/info" \ --header "Content-Type: application / json" \ --data-raw "{}"
  2. Você receberá um objeto JSON com detalhes sobre o serviço:
    Obtenha informações do CSC

Lista de Credenciais CSC

Lista de Credenciais CSC request irá recuperar uma credencial que você usará em solicitações de API posteriores.

Instruções do carteiroInstruções cURL
  1. Selecionar Lista de Credenciais CSC E clique no Autorização aba.
    Guia de autorização
  2. Escolha Símbolo do portador de Tipo menu, cole seu token de acesso no Token campo e clique no ENVIAR botão.
    Enviar pedido de lista de credenciais
  3. Um objeto JSON com uma lista de IDs de credenciais associados ao usuário aparecerá no Resposta campo. Sua lista provavelmente conterá um valor. Copie e cole seu ID de credencial em um editor de texto para uso em solicitações posteriores.
    IDs de credencial
  1. Digite o seguinte comando. (Substitua MY-ACCESS-TOKEN pelo seu token de acesso real):
    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/list" \ --header "Content-Type: application / json" \ --header "Autorização: Bearer MY- TOKEN DE ACESSO "\ --data-raw" {} "
  2. Você deve receber um objeto JSON com uma lista de IDs de credenciais associados ao usuário. Sua lista provavelmente conterá um valor. Copie e cole seu ID de credencial em um editor de texto para uso em solicitações posteriores.
    IDs de credencial

Informações de credenciais do CSC (opcional)

O Informações de credenciais do CSC a solicitação retornará certificados e outras informações associadas a uma ID de credencial e não é necessária para assinatura.

Instruções do carteiroInstruções cURL
  1. Para usar esta solicitação, selecione Informações de credenciais do CSC da coleção e clique no Autorização aba.
    guia de autorização
  2. Escolha Símbolo do portador de Tipo menu e cole seu token de acesso no Token campo.
    Colar token
  3. Selecione os Corpo guia e cole seu ID de credencial como o valor para credentialID.
    Colar ID de credencial
  4. Clique na ENVIAR botão.
    ENVIAR
  5. Um objeto JSON com sua cadeia de certificados de assinatura e outras informações aparecerão no Resposta campo.
    Informação de credenciais
  1. Digite o seguinte comando. Substituir MY-ACCESS-TOKEN e MY-CREDENTIAL-ID com suas informações reais:
    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/info" \ --header "Content-Type: application / json" \ --header "Autorização: Bearer MY- ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "certificados \": \ "cadeia \", \ "certInfo \": verdadeiro, \ " authInfo \ ": true}"
  2. Você deve receber um objeto JSON com sua cadeia de certificados de assinatura e outras informações:
    Informações de credenciais do CSC

Autorizar credenciais

O Autorizar credenciais a solicitação recuperará a autorização para assinar um hash.

Instruções do carteiroInstruções cURL
  1. Comece selecionando Autorizar credenciais da coleção e clicando no Autorização aba.
    Guia de autorização
  2. Escolha Símbolo do portador de Tipo menu e cole seu token de acesso no Token campo.
    colar token
  3. Selecione os Corpo aba. Cole seu ID de credencial como o credentialID valor e um hash do documento que você deseja assinar como o hash valor. Recupere e insira um OTP de seu aplicativo de autenticação e insira-o como o valor para OTP, Então clique no ENVIAR botão.
    Aba do corpo
  4. Um objeto JSON com seus Dados de Ativação de Assinatura (SAD) aparecerá no Resposta campo. Copie e cole esse valor em um editor de texto para usar na solicitação de assinatura hash.
    SAD
  1. Use o seguinte comando. Substituir MY-ACCESS-TOKEN, MY-CREDENTIAL-IDe MY-HASH com suas informações reais. Obtenha uma senha única de seu aplicativo 2FA e use-a como o valor para MY-OTP.
    curl --location --request POST "https://cs.ssl.com/csc/v0/credentials/authorize" \ --header "Content-Type: application / json" \ --header "Autorização: Bearer MY- ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "numSignatures \": 1, \ "hash \": [\ "MY-HASH \" ], \ "OTP \": \ "MY-OTP \"} "
  2. Você deve receber um objeto JSON com seus Dados de Ativação de Assinatura (SAD). Copie e cole esse valor em um editor de texto para usar na solicitação de assinatura hash.
    Autorizar credenciais

Assinar Hash

Agora você está pronto para assinar o hash do documento.

Instruções do carteiroInstruções cURL
  1. Selecionar Assinar Hash da coleção e, em seguida, selecione o Autorização aba.
    Guia de autorização
  2. Escolha Símbolo do portador de Tipo menu e cole seu token de acesso no Token campo.
    Colar token
  3. Selecione os Corpo aba. Cole seu ID de credencial como o credentialID valor, seus dados de ativação de assinatura como o SAD valor, e um hash do documento que você deseja assinar como o hash valor e clique no ENVIAR botão.
    Aba do corpo
  4. Um objeto JSON com sua assinatura aparecerá no Resposta campo.
    Assinatura
  1. Digite o seguinte comando. Substituir MY-ACCESS-TOKENMY-CREDENTIAL-ID, MY-SADe MY-HASH com suas informações reais:
    curl --location --request POST "https://cs.ssl.com/csc/v0/signatures/signHash" \ --header "Tipo de conteúdo: application / json" \ --header "Autorização: Bearer MY- ACCESS-TOKEN "\ --data-raw" {\ "credentialID \": \ "MY-CREDENTIAL-ID \", \ "SAD \": \ "MY-SAD \", \ "hash \": [\ "MY-HASH \"], \ "signAlgo \": \ "1.2.840.113549.1.1.11 \"} "
  2. Você deve receber um objeto JSON contendo sua assinatura.
    Assinar hash

Assine um PDF

Além de assinar hashes de documentos, você também pode fazer upload e assinar um arquivo PDF.

Ao assinar um PDF, você trabalhará com duas solicitações POST:

  • Carregar documento PDF
  • Assinar documento PDF

Coleção da API de assinatura de documentos

Você pode reutilizar a credencial recuperada acima com o Lista de Credenciais CSC solicitação. Você provavelmente também precisará recuperar um novo token de acesso.

Carregar documento PDF

Instruções do carteiroInstruções cURL
  1. Selecione os Carregar documento PDF solicitar e clicar no Autorização aba.
    Guia de autorização
  2. Escolha Símbolo do portador de Tipo menu e cole seu token de acesso no Token campo.
    Colar token
  3. Selecione os Cabeçalhos guia e cole seu ID de credencial no Valor coluna.
    Aba de cabeçalhos
  4. Selecione os Corpo guia e clique no × próximo de hello.pdf para remover este nome de arquivo de espaço reservado.
    remover nome de arquivo de exemplo
  5. Clique na Selecione o arquivo e navegue até o arquivo que deseja enviar.
    Selecione o arquivo
  6. Clique na ENVIAR botão.
    ENVIAR
  7. Selecione e copie o id valor na resposta para usar na próxima solicitação.
    ID
  1. Use o seguinte comando. Substituir MY-CREDENTIAL-ID, MY-ACCESS-TOKENe /PATH/TO/FILE.pdf com suas informações reais:
    curl --location --request POST "https://ds.ssl.com/v1/pdf/upload" \ --header "Credential-Id: MY-CREDENTIAL-ID" \ --header "Autorização: Bearer MY- ACCESS-TOKEN "\ --header" Content-Type: application / pdf "\ --data-binary" @ / PATH / TO / FILE.pdf "
  2. Você receberá um objeto JSON com um valor para id. Copie este valor para usar na próxima solicitação.
    Upload de PDF

Assinar documento PDF

Agora você pode assinar o PDF.

A autorização OTP não é necessária ao assinar usando um certificado de assinatura de documento de vedação. Ignore todos os parâmetros OTP no guia a seguir se estiver usando um certificado de assinatura de documento de vedação.
Instruções do carteiroInstruções cURL
  1. Selecione os Carregar documento PDF solicitar e clicar no Autorização aba.
       Autorização
  2. Escolha Símbolo do portador de Tipo menu e cole seu token de acesso no Token campo.
    Colar token
  3. Selecione a guia Corpo, cole no id valor da etapa anterior e um OTP do seu aplicativo de autenticação, em seguida, clique no ENVIAR botão.
    Enviar solicitação
  4. Os dados do PDF aparecerão abaixo no Resposta campo. Escolher Salvar em um arquivo de Salvar resposta menu e, em seguida, dê um nome ao arquivo.
    Salvar PDF em arquivo
  5. Abra o arquivo no Acrobat para confirmar se o arquivo foi assinado.
    Assinatura Válida
  1. Digite o seguinte comando. Substituir MY-CREDENTIAL-ID, MY-FILE-IDe OUTPUT-FILENAME com suas informações reais. Obtenha uma senha única (OTP) de seu aplicativo 2FA e insira-a como MY-OTP:
    curl --location --request POST 'https://ds.ssl.com/v1/pdf/sign' \ --header 'Content-Transfer-Encoding: application / json' \ --header 'Content-Type: application / json '\ --header' Autorização: Bearer MY-ACCESS-TOKEN '\ --data-raw' {"id": "MY-FILE-ID", "otp": "MY-OTP"} '\ - -output OUTPUT-FILENAME
  2. cURL irá baixar o arquivo assinado e salvá-lo com o nome de arquivo que você especificou:
    Assinar PDF
  3. Abra o PDF no Acrobat ou Acrobat Reader para verificar se a assinatura é válida.
    Assinatura válida

Partilhar no Twitter
Twitter
Partilhar no Facebook
Facebook
Partilhar no LinkedIn
LinkedIn
Share on reddit
Reddit
Compartilhar no email
Email