Updating a template of e-sign document

1. 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'}
   

2. Define a variable named template_id, and then assign an ID of the template to this variable:

   >>> template_id = '3922edc2-d70d-4d5d-9789-5d739a6e7bdc'
   

3. Define a variable named template_data, and then assign an object with a new name of the template to this variable:

   >>> template_data = {
   ...     'name': 'Contract Template'
   ... }
   

4. Convert the template_data object to a JSON text:

   >>> template_data = json.dumps(template_data, indent=4)
   >>> print(template_data)
   {
       "name": "Contract Template"
   }
   

5. Send a PUT request with the JSON text to the /templates/{template_id} endpoint:

   >>> response = requests.put(
   ...     f'{base_url}/templates/{template_id}',
   ...     headers={'Content-Type': 'application/json', **auth},
   ...     data=template_data,
   ... )
   

6. Check the status code of the response:

   >>> response.status_code
   200
   

   Status code 200 means that the notary service has updated the name of the e-sign document template.

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

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 "template_id" and then assign it with an ID of the e-sign document template
template_id = '3922edc2-d70d-4d5d-9789-5d739a6e7bdc'

# Define a variable named "template_data", and then assign an object with a new name of the template to this variable
template_data = {
    'name': 'Contract Template'
}

# Convert the template_data object to a JSON text:
template_data = json.dumps(template_data, indent=4)

# Update the name of the e-sign document by sending a PUT request to the "/templates/{template_id}" endpoint
response = requests.put(
    f'{base_url}/templates/{template_id}',
    headers={'Content-Type': 'application/json', **auth},
    data=template_data,
)
response.raise_for_status()