OneSpan Sign Cómo: Hacer llamadas REST a la API de OneSpan Sign en Python

Haris Haidary, 3 de Agosto de 2016
Thumbnail

Python es uno de los lenguajes de programación de propósito general más populares disponibles. Se utiliza en muchos dominios de aplicación, como: aplicaciones web, desarrollo de software, GUI de escritorio, etc. Su popularidad entre los desarrolladores se debe a tres razones distintas:

  • Legibilidad
  • Bibliotecas
  • Comunidad

Python enfatiza en la facilidad con la que un usuario puede entender y escribir código. Como resultado, su sintaxis permite al desarrollador escribir conceptos equivalentes en menos líneas de código que Java o C ++. Además, Python ha existido por más de dos décadas. Por lo tanto, tiene una gran biblioteca estándar que prueba las herramientas adecuadas para muchas aplicaciones. Por último, pero no menos importante, Python también tiene una vasta comunidad, donde puede encontrar fácilmente soporte. En este blog, le mostraré cómo hacer llamadas REST a la API de OneSpan Sign en Python.

El código

Para este blog, usaré Python 2.7. Si aún no lo tiene instalado, puede descargarlo de su sitio web oficial, aquí . También puede obtener el código de ejemplo completo de la Comunidad de desarrolladores Código compartido . Lo primero que querrá hacer es instalar el módulo 'solicitudes'. Esto le permitirá realizar solicitudes HTTP a la API de OneSpan Sign. Abra su símbolo del sistema e ingrese la siguiente línea:

Solicitudes de instalación de $ pip

pipa

Ahora, en su editor de texto favorito, cree un nuevo archivo llamado "createAndSendPackage.py" y guárdelo en la ubicación que elija. Continúa y copia el código a continuación. Lo examinaré con más detalle más abajo.

solicitudes de importación
importar json

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

payload = json.dumps ({"documents": [{"id": "sample-contract", "name": "Test Document"}], "status": "SENT", "type": "PACKAGE", "roles": [{"type": "SIGNER", "id": "Signer1", "signers": [{"email": "signer @example .com "," firstName ":" John "," lastName ":" Smith "," id ":" Signer1 "}]," name ":" Signer1 "}]," name ":" Paquete de ejemplo "})

archivo = abierto ('doc1.pdf', 'rb')

archivos = {
     'payload': carga útil,
     'archivo': archivo
}

encabezados = {
    'autorización': "Basic your_api_key",
    'accept': "aplicación / json"
    }

respuesta = solicitudes.post (url, archivos = archivos, encabezados = encabezados)
print (respuesta.text)

Ahora, repasemos el código con mayor detalle. El primer par de líneas importa los módulos necesarios para realizar llamadas REST.

solicitudes de importación
importar json

La siguiente línea es la URL del punto final donde enviará su solicitud POST.

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

Luego, se crea la cadena JSON que define su paquete. Por lo general, construiría su cadena JSON dinámicamente en lugar de tener una cadena grande como la siguiente. Elegí hacerlo por simplicidad.

payload = json.dumps ({"documents": [{"id": "sample-contract", "name": "Test Document"}], "status": "DRAFT", "type": "PACKAGE", "roles": [{"type": "SIGNER", "id": "Signer1", "signers": [{"email": "signer @example .com "," firstName ":" John "," lastName ":" Smith "," id ":" Signer1 "}]," name ":" Signer1 "}]," name ":" Paquete de ejemplo "})

A continuación, se leen los binarios del documento y se construye la carga útil de solicitud adecuada.

archivo = abierto ('doc1.pdf', 'rb')

archivos = {
     'payload': carga útil,
     'archivo': archivo
}

Finalmente, se definen los encabezados y se realiza la solicitud POST para crear y enviar su paquete. Asegúrese de reemplazar el marcador de posición de la clave de API con su propio valor.

encabezados = {
    'autorización': "Basic your_api_key",
    'accept': "aplicación / json"
    }

respuesta = solicitudes.post (url, archivos = archivos, encabezados = encabezados)
print (respuesta.text)

Ejecutando su código

Abra su símbolo del sistema y cambie el directorio actual a la ubicación donde guardó su archivo "createAndSendPackage.py". Luego, ingrese la siguiente línea:

python createAndSendPackage.py

OneSpan Sign devolverá una identificación del paquete como respuesta, que se imprimirá en la ventana del símbolo del sistema.

1 Si tiene preguntas sobre este blog o cualquier otra cosa relacionada con la integración de OneSpan Sign en su aplicación, visite los foros de la comunidad de desarrolladores: https://community.onespan.com . Eso es todo de mi parte. ¡Gracias por leer! Si esta publicación le parece útil, compártala en Facebook, Twitter o LinkedIn.

Haris Haidary
Evangelista Técnico Junior
LinkedIn El | Gorjeo