Doc::CS API: Difference between revisions

From Computer Science Wiki
Jump to navigation Jump to search
(Created page with "== Overview == This service is in beta. A REST api to access/update certain departmental information is available at https://api.cs.vt.edu == Authentication == Authenticat...")
 
No edit summary
Line 16: Line 16:
Look up user information by Hokie ID  
Look up user information by Hokie ID  
<code>curl -H 'Accept: application/json; indent=4' -u myservice https://api.cs.vt.edu/hokieids/99999999</code>
<code>curl -H 'Accept: application/json; indent=4' -u myservice https://api.cs.vt.edu/hokieids/99999999</code>
=== Python ===
A simple example using ptyhon
<pre>
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)
</pre>

Revision as of 15:07, 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. Replaces '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)