API_Examples/Example3.py at master · ThinkSmart/API_Examples · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# Example3.py
# Authorization Code Flow
# written and tested in Python 3.6.0
# last updated 07/07/17

import webbrowser
import requests
import json
import time

# ---------------- #
# Global Variables #
# ---------------- #

# replace tenant with your own
url_root = 'https://tenant.tap.thinksmart.com/prod/'
# fill in (must be strings)
client_id = ''
client_secret = ''
redirect_uri = ''
workflow_name = ''

# --------- #
# Functions #
# --------- #

def getBrowser(url_root, client_id, redirect_uri):
	"""
	Given: URL root, client ID, and redirect URI.
	Return: None, opens browser for user to enter credentials.
	"""

	# construct URL
	url = ('{}auth/identity/connect/authorize?client_id={}&scope=api&response_type=code&redirect_uri={}'
					.format(url_root, client_id, redirect_uri))

	# open browser
	webbrowser.open_new(url)

def getToken(url_root, code, client_id, client_secret):
	"""
	Given: URL root, code, and client info.
	Return: Access token, valid for 1 hour.
	"""

	# construct URL
	url = '{}auth/identity/connect/token'.format(url_root)

	# static header, see docs.thinksmart1.apiary.io for documentation
	headers = {'Content-Type' : 'x-www-form-urlencoded'}

	# create dict for body
	body = {'grant_type' : 'authorization_code',
					'scope' : 'api',
					'redirect_uri' : 'https://google.com',
					'code' : code,
					'client_id' : client_id,
					'client_secret' : client_secret}

	# make API call
	r = requests.post(url, headers=headers, data=body)

	# parse POST call response, return token
	return json.loads(r.text).get('access_token')

def getTemplateID(url_root, workflow_name, token):
	"""
	Given: URL root, name of workflow, and valid token.
	Return: Template ID of workflow.
	"""

	# construct URL
	# workflow_name must be quoted, e.g. ?$filter=WorkflowName eq 'CamTest'
	url = ("{}api/v1/templates/dashboard?$filter=WorkflowName eq '{}'"
					.format(url_root, workflow_name))

	# needs token
	headers = {'Authorization' : 'Bearer {}'.format(token)}

	# make API call
	r = requests.get(url, headers=headers)

	# parse GET call response, return template ID
	return json.loads(r.text).get('Items')[0].get('ID')

def initiateWorkflow(url_root, template_id, token, body):
	"""
	Given: URL root, ID of workflow, valid token, and field names and values.
	Return: None, makes POST call to initiate workflow.
	"""

	# construct URL
	url = '{}api/v1/workflows/{}/form'.format(url_root, template_id)

	# needs token
	headers = {'Authorization' : 'Bearer {}'.format(token),
							'Content-Type' : 'application/json'}

	# encode body into JSON
	json_body = json.dumps(body)

	# make API call
	requests.post(url, headers=headers, data=json_body)

# -------------- #
# Function Calls #
# -------------- #

# give info
print("In a few seconds, a tab in your browser will open. " +
			"Please enter your TAP credentials, then copy and paste " +
			"the URL of the redirect page into the space below.")
# delay
time.sleep(3)

# open browser, take URL as input, parse for code
getBrowser(url_root, client_id, redirect_uri)
redirect = input("URL of redirect page: ")
# the parsing here works with redirect_uri = 'https://google.com'
code = redirect.split('code=')[1]

# get token
token = getToken(url_root, code, client_id, client_secret)

# get template ID
template_id = getTemplateID(url_root, workflow_name, token)

# a dictionary is used to fill fields in the workflow
# keys are field names, values are field values
# below is an example of what it may look like
body = {"element1": "Hello", "element2": "World"}

# initiate workflow
initiateWorkflow(url_root, template_id, token, body)