Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
api:manual [2019/02/25 12:41]
Anton Smirnov Links to scoresheet calls
api:manual [2020/05/11 16:12] (current)
Lauri Elevant
Line 38: Line 38:
 That's it! We derive most of the security mechanism from the use of HTTPS, most notably confidentiality (of the API key as well as the data sent and received), integrity (data cannot be altered while "in transit") and mitigation against man-in-the-middle and re-play attacks. That's it! We derive most of the security mechanism from the use of HTTPS, most notably confidentiality (of the API key as well as the data sent and received), integrity (data cannot be altered while "in transit") and mitigation against man-in-the-middle and re-play attacks.
  
 +Here is a quick way to make your first API request:
 +  
 +  curl -v -X GET -H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" https://apply.uni.edu/api/institutions
  
 +On the request above, ''apply.uni.edu'' is the domain for your DreamApply installation. It may also be in the form of "your-uni.dreamapply.com" if you have not yet configured the domain in DreamApply settings. Tip - you can add ''| python -m json.tool'' to the end of the command if you expect to receive JSON data (not all API queries return JSON) to prettify the output.
 ===== Versioning ===== ===== Versioning =====
  
Line 130: Line 134:
 | [[api:/api/applicants/ID/applications|/api/applicants/ID/applications]] | C | GET HEAD | List applications for this applicant | | [[api:/api/applicants/ID/applications|/api/applicants/ID/applications]] | C | GET HEAD | List applications for this applicant |
 | [[api:/api/applicants/ID/applications/ID|/api/applicants/ID/applications/ID]] | R | GET HEAD | Get information about an applicant application | | [[api:/api/applicants/ID/applications/ID|/api/applicants/ID/applications/ID]] | R | GET HEAD | Get information about an applicant application |
 +| [[api:/api/applicants/ID/reference|/api/applicants/ID/reference]] | R | GET HEAD | Get the reference code for this applicant |
 +| [[api:/api/applicants/ID/reference|/api/applicants/ID/reference]] | R | PUT | Store a new reference code for this applicant |
 | [[api:/api/applicants/consents|/api/applicants/consents]] | C | GET HEAD | Get a list of all consents | | [[api:/api/applicants/consents|/api/applicants/consents]] | C | GET HEAD | Get a list of all consents |
 | [[api:/api/applicants/consents/ID|/api/applicants/consents/ID]] | R | GET HEAD | Get information about a specific consent | | [[api:/api/applicants/consents/ID|/api/applicants/consents/ID]] | R | GET HEAD | Get information about a specific consent |
Line 161: Line 167:
 | [[api:/api/applications/ID/documents|/api/applications/ID/documents]] | C | GET HEAD | Get a list of documents attached to this application | | [[api:/api/applications/ID/documents|/api/applications/ID/documents]] | C | GET HEAD | Get a list of documents attached to this application |
 | [[api:/api/applications/ID/documents/ID|/api/applications/ID/documents/ID]] | R | GET HEAD | Get a specific applicant document (binary data) | | [[api:/api/applications/ID/documents/ID|/api/applications/ID/documents/ID]] | R | GET HEAD | Get a specific applicant document (binary data) |
 +| [[api:/api/applications/ID/scores|/api/applications/ID/scores]] | C | GET HEAD | Get a list of scores for this application |
 | [[api:/api/applications/ID/studyplans|/api/applications/ID/studyplans]] | C | GET HEAD | Get a list of study plans attached to this application | | [[api:/api/applications/ID/studyplans|/api/applications/ID/studyplans]] | C | GET HEAD | Get a list of study plans attached to this application |
 | [[api:/api/applications/ID/studyplans/ID|/api/applications/ID/studyplans/ID]] | R | GET HEAD | Get a specific study plan attached to this application | | [[api:/api/applications/ID/studyplans/ID|/api/applications/ID/studyplans/ID]] | R | GET HEAD | Get a specific study plan attached to this application |
Line 173: Line 180:
 | [[api:/api/institutions/ID/departments|/api/institutions/ID/departments]] | C | GET HEAD | List departments under the given institution | | [[api:/api/institutions/ID/departments|/api/institutions/ID/departments]] | C | GET HEAD | List departments under the given institution |
 | [[api:/api/institutions/ID/departments/ID|/api/institutions/ID/departments/ID]] | R | GET HEAD | Show information about a given institution department | | [[api:/api/institutions/ID/departments/ID|/api/institutions/ID/departments/ID]] | R | GET HEAD | Show information about a given institution department |
-| [[api:/api/institutions/ID/contacts|/api/institutions/ID/contacts]] | C | GET HEAD | List contact persons under the given institution | 
-| [[api:/api/institutions/ID/contacts/ID|/api/institutions/ID/contacts/ID]] | R | GET HEAD | Show information about a given institution contact person | 
 | [[api:/api/courses|/api/courses]] | C | GET HEAD | List courses using filters set as parameters | | [[api:/api/courses|/api/courses]] | C | GET HEAD | List courses using filters set as parameters |
 +| [[api:/api/courses|/api/courses]] | C | POST | Create a new blank course |
 | [[api:/api/courses/ID|/api/courses/ID]] | R | GET HEAD | More detailed information about a specific course | | [[api:/api/courses/ID|/api/courses/ID]] | R | GET HEAD | More detailed information about a specific course |
 | [[api:/api/intakes|/api/intakes]] | R | GET HEAD | List configured intakes | | [[api:/api/intakes|/api/intakes]] | R | GET HEAD | List configured intakes |
Line 223: Line 229:
 ===== Throttling  ===== ===== Throttling  =====
  
-All API calls placed to the same API key are, by default, limited to **60 queries per minute** and **600 queries per hour**. Please note that 60 queries/minute is not the same as 1 query per second, see below.+All API calls placed to the same API key are, by default, limited to **180 queries per minute** and **600 queries per hour**. Please note that 60 queries/minute is not the same as 1 query per second, see below.
  
 If you exceed your API key queries-per-minute quota, you may start to receive ''429 Too Many Requests'' responses. This means that the request was **not** processed and will have to be issued again. If you exceed your API key queries-per-minute quota, you may start to receive ''429 Too Many Requests'' responses. This means that the request was **not** processed and will have to be issued again.