-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathveracross.py
211 lines (187 loc) · 8.55 KB
/
veracross.py
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# Veracross Data API v3
import requests
import time
class Client:
# Constructor
def __init__(self, client_id, client_secret, school_route):
self.client_id = client_id
self.client_secret = client_secret
self.school_route = school_route
# Retrieve Access Token
def get_access_token(self, scope):
client_id = self.client_id
client_secret = self.client_secret
school_route = self.school_route
school_base_url = 'https://accounts.veracross.com/'+school_route
url_address = school_base_url+'/oauth/token' # Set destination URL here
data = {
"client_id": client_id,
"client_secret": client_secret,
"grant_type": "client_credentials",
"scope": scope
}
headers = {
"Content-Type": "application/x-www-form-urlencoded"
}
resp = requests.post(url=url_address, headers=headers, data=data)
# print(resp.__dict__)
if( resp.status_code == 200):
return resp.json()['access_token']
else:
return False
# Rate Limiting
def rate_limit(self, limit_balance):
sleep_for = ((limit_balance) - time.time()) / 1000
print(f"Sleeping for {sleep_for}")
time.sleep(sleep_for)
# List
def list(self, scopes, path, params={}):
client_id = self.client_id
client_secret = self.client_secret
school_route = self.school_route
api_base_url = 'https://api.veracross.com/'+school_route+'/v3'
if(scopes):
access_token = self.get_access_token(scopes)
if(access_token):
url_address = api_base_url+'/'+path # Set destination URL here
page_number = 1
page_size = 1000
all_records = []
while(1):
headers = {
"Content-Type": "application/json",
"authorization": "Bearer "+ access_token,
"X-Page-Number": str(page_number),
"X-Page-Size": str(page_size)
}
resp = requests.get(url=url_address, headers=headers, params=params)
if(resp.status_code == 200):
# enforcing rate-limits
if(int(resp.headers['X-Rate-Limit-Remaining']) == 1):
self.rate_limit(int(resp.headers['X-Rate-Limit-Reset']))
# increment page number
this_response = resp.json()['data']
all_records.append(this_response)
if(len(this_response) > page_size):
page_number += 1
else:
return all_records
else:
raise ValueError(f"API call failed with error code {resp.status_code}. Please refer API documentation.")
# return 'false' # error - http
else:
raise ValueError(f"Error retrieving access token.")
# return 'false' # error - access token
else:
raise ValueError(f"Error setting the scopes.")
# return 'false' # error - setting scopes
# Read
def read(self, scopes, path):
client_id = self.client_id
client_secret = self.client_secret
school_route = self.school_route
api_base_url = 'https://api.veracross.com/'+school_route+'/v3'
if(scopes):
access_token = self.get_access_token(scopes)
if(access_token):
url_address = api_base_url+'/'+path # Set destination URL here
headers = {
"Content-Type": "application/json",
"authorization": "Bearer "+ access_token
}
resp = requests.get(url=url_address, headers=headers)
if(resp.status_code == 200):
this_response = resp.json()['data']
return this_response
else:
raise ValueError(f"API call failed with error code {resp.status_code}. Please refer API documentation.")
# return 'false' # error - http
else:
raise ValueError(f"Error retrieving access token.")
# return 'false' # error - access token
else:
raise ValueError(f"Error setting the scopes.")
# return 'false' # error - setting scopes
# Update
def update(self, scopes, path, payload):
client_id = self.client_id
client_secret = self.client_secret
school_route = self.school_route
api_base_url = 'https://api.veracross.com/'+school_route+'/v3'
if(scopes):
access_token = self.get_access_token(scopes)
if(access_token):
url_address = api_base_url+'/'+path # Set destination URL here
headers = {
"Content-Type": "application/json",
"authorization": "Bearer "+ access_token
}
resp = requests.patch(url=url_address, json=payload, headers=headers)
if(resp.status_code == 204):
this_response = resp.status_code
return this_response
else:
raise ValueError(f"API call failed with error code {resp.status_code}. Please refer API documentation.")
# return 'false' # error - http
else:
raise ValueError(f"Error retrieving access token.")
# return 'false' # error - access token
else:
raise ValueError(f"Error setting the scopes.")
# return 'false' # error - setting scopes
# Create
def create(self, scopes, path, payload):
client_id = self.client_id
client_secret = self.client_secret
school_route = self.school_route
api_base_url = 'https://api.veracross.com/'+school_route+'/v3'
if(scopes):
access_token = self.get_access_token(scopes)
if(access_token):
url_address = api_base_url+'/'+path # Set destination URL here
headers = {
"Content-Type": "application/json",
"authorization": "Bearer "+ access_token
}
resp = requests.post(url=url_address, json=payload, headers=headers)
if(resp.status_code == 201):
this_response = resp.status_code
return this_response
else:
error_code = resp.json()['error_id']
error_message = resp.json()['error']
raise ValueError(f"API call failed with error code {error_code}. Error Message: {error_message}. Please refer API documentation. ")
# return 'false' # error - http
else:
raise ValueError(f"Error retrieving access token.")
# return 'false' # error - access token
else:
raise ValueError(f"Error setting the scopes.")
# return 'false' # error - setting scopes
# Delete
def delete(self, scopes, path):
client_id = self.client_id
client_secret = self.client_secret
school_route = self.school_route
api_base_url = 'https://api.veracross.com/'+school_route+'/v3'
if(scopes):
access_token = self.get_access_token(scopes)
if(access_token):
url_address = api_base_url+'/'+path # Set destination URL here
headers = {
"Content-Type": "application/json",
"authorization": "Bearer "+ access_token
}
resp = requests.delete(url=url_address, headers=headers)
if(resp.status_code == 204):
this_response = resp.status_code
return this_response
else:
raise ValueError(f"API call failed with error code {resp.status_code}. Please refer API documentation.")
# return 'false' # error - http
else:
raise ValueError(f"Error retrieving access token.")
# return 'false' # error - access token
else:
raise ValueError(f"Error setting the scopes.")
# return 'false' # error - setting scopes