Doc::CS API: Difference between revisions
Jump to navigation
Jump to search
m Protected "Doc::CS API" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)) |
No edit summary |
||
| Line 12: | Line 12: | ||
=== Curl === | === Curl === | ||
This example uses the <code>curl</code> command to access the api. | This example uses the <code>curl</code> command to access the api. Replace 'myservice' with the username of your service. | ||
Look up user information by Hokie ID | Look up user information by Hokie ID | ||
Revision as of 14:17, 13 October 2020
Overview
This service is in beta.
A REST api to access/update certain departmental information is available at https://api.cs.vt.edu
Authentication
Authentication is made with a unique username/password combination for each service needing access to the API. Access will be limited to the individual items need by the service.
Examples
Curl
This example uses the curl command to access the api. Replace 'myservice' with the username of your service.
Look up user information by Hokie ID
curl -H 'Accept: application/json; indent=4' -u myservice https://api.cs.vt.edu/hokieids/99999999
Python
A simple example using ptyhon
import requests
from requests.auth import HTTPBasicAuth
base_url = 'https://api.cs.vt.edu/hokieids/'
uid = 1
response = requests.get(base_url + str(uid) + '/', auth=HTTPBasicAuth('myservice', 'mypassword'))
if response.status_code is 200:
data = response.json()
print(data['display_name'])
else:
print(response.text)