API Basics
Last updated
Last updated
If you've never worked with REST API's in the past, hopefully this document can serve as a good springboard for you to start using ours.
Most of the time, you'll be PULLing data from AlumnIQ. There are some places where you can use the API to PUSH updates and new data to us, but to get started we'll only focus on the PULL aspect.
The process goes like this:
Your program makes an HTTP request to get some data
The AlumnIQ API returns the data as JSON
Your program parses the JSON into your language's data format
You use the data to update your database
Most programming/scripting environments have the ability to make HTTP requests:
Unix/Linux computers can use curl () or wget (), among others.
Windows Powershell users can use Invoke-WebRequest () or Invoke-RestMethod ().
Python scripts can use the requests module ().
Oracle supports UTL_HTTP () though we strongly recommend against embedding API logic in your database scripts. Generally integrations require more logic than is ideal to keep in the DB.
Generally, our customers create recurring scheduled jobs to pull data from the AlumnIQ API on a regular basis (e.g. daily), and those jobs manage the process of making the HTTP requests, handling the JSON response data, and updating the databases.
Most modern programming environments have access to some libraries or tooling that make working with JSON easy.
When browsing our API docs or the docs on , you may notice that we sometimes use these verbs prominently: GET, POST, PUT, and DELETE. They roughly correspond to READ, CREATE, UPDATE, and DELETE. When making an HTTP request, you will get to provide a verb (or method); with the default usually being GET. You can change that to POST or PUT (where allowed by our API) to push data into AlumnIQ.
is a web standard for transmitting data efficiently. It can include Objects (sometimes referred to as structs/structures or maps), Arrays (sometimes called lists), numbers, strings, nulls, and booleans. Objects and arrays can contain more objects and arrays, and numbers, strings, nulls, and booleans.