OneSpan Sign Como: Fazer chamadas REST para a API do OneSpan Sign em Python

Haris Haidary, 3 de Agosto de 2016
Thumbnail

Python é uma das linguagens de programação de uso geral mais populares disponíveis. É usado em muitos domínios de aplicativos, como: aplicativos Web, desenvolvimento de software, GUIs de desktops, etc. Sua popularidade entre os desenvolvedores se deve a três razões distintas:

  • Legibilidade
  • Bibliotecas
  • Comunidade

O Python enfatiza a facilidade com que um usuário pode entender e escrever código. Como resultado, sua sintaxe permite que o desenvolvedor escreva os conceitos equivalentes em menos linhas de código que Java ou C ++. Além disso, o Python existe há mais de duas décadas. Por isso, possui uma grande biblioteca padrão de ferramentas de teste adequadas a muitos aplicativos. Por último, mas não menos importante, o Python também tem uma vasta comunidade, onde você pode encontrar facilmente suporte. Neste blog, mostrarei como fazer chamadas REST para a API do OneSpan Sign em Python.

O código

Neste blog, usarei o Python 2.7. Se você ainda não o instalou, pode fazer o download no site oficial, aqui . Você também pode obter o código de exemplo completo na Comunidade do desenvolvedor Partilha de código . A primeira coisa que você deseja fazer é instalar o módulo 'solicitações'. Isso permitirá que você faça solicitações HTTP para a API do OneSpan Sign. Abra seu prompt de comando e digite a seguinte linha:

Solicitações de instalação do $ pip

pip

Agora, no seu editor de texto favorito, crie um novo arquivo chamado "createAndSendPackage.py" e salve-o no local de sua escolha. Vá em frente e copie o código abaixo. Examinarei isso com mais detalhes mais adiante.

pedidos de importação
json de importação

url = "https://sandbox.esignlive.com/api/packages"

payload = json.dumps ({"documents": [{"id": "sample-contract", "name": "Test Document"}], "status": "SENT", "type": "PACKAGE", "papéis": [{"type": "SIGNER", "id": "Signer1", "signatários": [{"email": "signatário @example .com "," firstName ":" John "," lastName ":" Smith "," id ":" Signer1 "}]," name ":" Signer1 "}]," name ":" Exemplo de pacote "})

arquivo = aberto ('doc1.pdf', 'rb')

files = {
     «carga útil»: carga útil,
     'arquivo': arquivo
}

cabeçalhos = {
    'autorização': "sua_api_key básica",
    'accept': "application / json"
    }

response = orders.post (url, arquivos = arquivos, cabeçalhos = cabeçalhos)
print (response.text)

Agora, vamos revisar o código em mais detalhes. O primeiro par de linhas importa os módulos necessários para fazer chamadas REST.

pedidos de importação
json de importação

A próxima linha é o URL do terminal para o qual você enviará sua solicitação POST.

url = https://sandbox.esignlive.com/api/packages

Em seguida, a cadeia JSON que define seu pacote é criada. Normalmente, você constrói sua string JSON dinamicamente versus uma string grande como a abaixo. Eu escolhi fazê-lo por simplicidade.

payload = json.dumps ({"documents": [{"id": "sample-contract", "name": "Test Document"}], "status": "DRAFT", "type": "PACKAGE", "papéis": [{"type": "SIGNER", "id": "Signer1", "signatários": [{"email": "signatário @example .com "," firstName ":" John "," lastName ":" Smith "," id ":" Signer1 "}]," name ":" Signer1 "}]," name ":" Exemplo de pacote "})

Em seguida, os binários do documento são lidos e a carga útil da solicitação apropriada é construída.

arquivo = aberto ('doc1.pdf', 'rb')

files = {
     «carga útil»: carga útil,
     'arquivo': arquivo
}

Finalmente, os cabeçalhos são definidos e a solicitação POST é feita para criar e enviar seu pacote. Substitua o espaço reservado da chave da API por seu próprio valor.

cabeçalhos = {
    'autorização': "sua_api_key básica",
    'accept': "application / json"
    }

response = orders.post (url, arquivos = arquivos, cabeçalhos = cabeçalhos)
print (response.text)

Executando seu código

Abra seu prompt de comando e altere o diretório atual para o local em que você salvou o arquivo "createAndSendPackage.py". Em seguida, digite a seguinte linha:

python createAndSendPackage.py

O OneSpan Sign retornará um ID do pacote como resposta, que será impresso na janela do prompt de comando.

 1 Se você tiver dúvidas sobre este blog ou qualquer outra coisa relacionada à integração do OneSpan Sign ao seu aplicativo, visite os fóruns da comunidade de desenvolvedores: https://community.onespan.com . É isso de mim. Obrigado pela leitura! Se você achou esta publicação útil, compartilhe-a no Facebook, Twitter ou LinkedIn.

Haris Haidary
Evangelista Técnico Júnior
LinkedIn | Twitter