Fetching signed and converted PDF files

Note

If you are signing the file by the permanent link and already have the ID of the document, skip steps 2-5.

Start the Python shell and configure its session.

The following variables should be available now:

>>> base_url  # the base URL of the API
'https://eu2-cloud.acronis.com/api/notary/v2'
>>> auth  # the 'Authorization' header value with the access token
{'Authorization': 'Bearer 8770b34b74f9e4d9424eff50c38182bb4ae7f5596582ae61900b1b6a23e3ec58'}

Define a variable named file_id, and then assign the ID of the file being or already signed to this variable:
```
>>> file_id = 'aa95bac7-33fd-4faa-9fa1-f4baeaca82cd'
```
Fetch the details about the file by sending a GET request to the /stored-files/{file_id} endpoint:
```
>>> response = requests.get(f'{base_url}/stored-files/{file_id}', headers=auth)
```
Check the status code of the response:
```
>>> response.status_code
200
```
Status code 200 means that the request was successful.

A different status code means that an error has occurred. For the details, refer to “Status and error codes”.

Also, the response body contains the file key containing the details about the file formatted as a JSON text. When converted to an object, it will look as follows:
```
>>> pprint.pprint(response.json())
{'file': {..., 'document': {...},
          'document_id': '8592b052a9979f8d651618092bb3ac8472beebc66d52ab980deb4d320e26b0cb'}}
```

Convert the JSON text that the response body contains to an object, and then fetch the ID of the document:

>>> doc_id = response.json()['file']['document_id']
>>> doc_id
'8592b052a9979f8d651618092bb3ac8472beebc66d52ab980deb4d320e26b0cb'

Fetch the details about the e-sign document by sending a GET request to the /documents/{doc_id} endpoint:
```
>>> response = requests.get(f'{base_url}/documents/{doc_id}', headers=auth)
```

Check the status code of the response:

>>> response.status_code
200

Status code 200 means that the request was successful.

A different status code means that an error has occurred. For the details, refer to “Status and error codes”.

Also, the response body contains the document key containing the details about the e-sign document formatted as a JSON text. When converted to an object, it will look as follows:

>>> pprint.pprint(response.json())
{'document': {'certificate_id': '',
              'id': '8eb2c5179b84a1b97a4f69eb0e97b4e910a1eace1b781926f83ee964f12e6922',
              'signed_at': null,
              'signature_certificate_link': '/doc/8eb2c5179b84a1b97a4f69eb0e97b4e910a1eace1b781926f83ee964f12e6922/download',
              ...
              'esign': {'embedded': True, 'converted_pdf_file_id': '60913aa1-3151-496a-a851-4063fd46982c'}
              'signees': [{'email': 'johndoe@mycompany.com',
                           'fullname': 'John Doe',
                           'id': '867139bf-30ca-4c83-8683-a30c5db57046',
                           'owner': True,
                           'signed_at': '2019-11-11T13:54:38.619811Z'},
                          {'email': 'foobar@othercompany.com',
                           'fullname': 'Foo Bar',
                           'id': '32ff6407-605c-4203-a611-34deb036cda4',
                           'owner': False,
                           'signed_at': null}]},
 'document_id': '8eb2c5179b84a1b97a4f69eb0e97b4e910a1eace1b781926f83ee964f12e6922',
 ...}}

Convert the JSON text that the response body contains to an object, and then fetch the value of the esign key of the document object:
```
>>> esign = response.json()['document']['esign']
```
Fetch the ID of the PDF file that needs to be downloaded:

If the file has been converted to PDF by the notary service, the ID of the converted PDF file can be fetched from the converted_pdf_file_id key:
```
>>> file_id = esign['converted_pdf_file_id']
```
If the file has been signed by all the signees, the ID of the signed version of the PDF file can be fetched from the signed_file_id key:
```
>>> file_id = esign['signed_file_id']
```
Download the PDF file by following the Downloading a file procedure.

Full code example

#!/usr/bin/env python3

import requests  # Will be used for sending requests to the API.
import hashlib   # Will be used for calculating hash values.
import os.path   # Will be used for path-related operations.
import pprint    # Will be used for formatting the output of JSON objects received in API responses.
import json      # Will be used for converting dictionaries into JSON text

# Define variables named "LOGIN" and "PASSWORD" and then assign them with your account credentials
LOGIN = '<your login>'        # Change login here
PASSWORD = '<your password>'  # Change password here

# Define a variable named "cloud_url" and then assign it with the URL of the cloud platform
cloud_url = 'https://cloud.acronis.com'

# Fetch the URL of the data center where your account is located by sending a GET request to the "/api/1/accounts" endpoint
response = requests.get(
    f'{cloud_url}/api/1/accounts',
    params={'login': LOGIN}
)
response.raise_for_status()

# Convert the JSON text that the response body contains to a dictionary and store the data center URL
# in a variable that will be used in further requests
server_url = response.json()['server_url']

# Define a variable named "account_creds", and then assign the username and password to this variable
account_creds = {
    'username': LOGIN,
    'password': PASSWORD
}

# Generate a token by sending a POST request to the "/api/2/idp/token" with your account credentials to the cloud platform
response = requests.post(
    f'{server_url}/api/2/idp/token',
    headers={'Content-Type': 'application/x-www-form-urlencoded'},
    data={'grant_type': 'password', **account_creds}
)
response.raise_for_status()

# Convert the JSON text that the response body contains to a dictionary and then assign it to a variable named "token_info"
token_info = response.json()

# Define a variable named "auth" and then assign it with a dictionary with "Authorization" key containing
# token string formatted as "Bearer <access_token>"
auth = {
    'Authorization': 'Bearer ' + token_info['access_token']
}

# Define a variable named "base_url", and then assign the API base URL using the data center URL
# to this variable
base_url = f'{server_url}/api/notary/v2'

# Define a variable named "file_id" and then assign it with the ID of the file
file_id = 'cc3ecc8d-de0e-4809-8bc2-3a6368110824'

# Fetch the information about the file by sending a GET request to the "/stored-files/{file_id}" endpoint
response = requests.get(f'{base_url}/stored-files/{file_id}', headers=auth)
response.raise_for_status()

# Define a variable named "esign" and store the "esign" object from the JSON response.
esign = response.json()['document']['esign']

# Check if the "esign" object contains the file ID in the "converted_pdf_file_id" key.
# If the "converted_pdf_file_id" key is absent, check if the object contains the "signed_file_id" key.
if 'converted_pdf_file_id' in esign:
    # Fetch the file ID of the converted PDF file
    file_id = esign['converted_pdf_file_id']
elif 'signed_file_id' in esign:
    # Fetch the file ID of the signed PDF file
    file_id = esign['signed_file_id']