For Developers

Edlink Postman Collection

One of the fastest ways to get familiar with the Edlink API is using our Postman collection. Postman is a GUI tool for making HTTP requests. If you have never used Postman, here is a video to give you an overview. It's a great tool that we use every day at Edlink.

Downloading Postman

If you have not already, the first step is downloading and installing Postman. You can find the appropriate version for your system on the Postman website.

After you have installed Postman and have it running, the next step is to import the Edlink Postman Collection. This collection contains most of the API endpoints that are available through Edlink. Import the Postman JSON collection by clicking on the Import button in Postman and importing the Edlink collection that you can download here.

Getting an Access Token

To make a request, you will need an access token. There is a detailed guide about the various types of Request Authorization here. For this example, we're going to make a request to the Graph API, so we will need an integration access token. We can use the integration access token from our sample application and sample integration to test. Here is how you can get the token from your sample integration.

Related Guides
Getting Sandbox Access
Graph API Authorization

Setting Environment Variables

Once you have the access token, you need to set the correct variable in Postman with the value you copied from the Edlink integration.

Setting the access token Postman
Setting the access token Postman

Running Your First Request

We can now run our first request. We will navigate through the folders of the available endpoints to find the Edlink Graph v2.0 List Classes endpoint. We will then click send to send our request to the Edlink API.

Sending a Postman request
Setting the access token Postman

Generating Code Snippets

For any Postman request, you can generate corresponding code snippets in popular languages.

Generating a Code Snippet From Your Request
Setting the access token Postman

Example Generated Code Snippet

Here is what the NodeJs Axios code snippet might look like for listing classes:

const axios = require('axios');

const config = {
    method: 'get',
    url: 'https://ed.link/api/v2/graph/classes',
    headers: {
        Authorization: 'Bearer your_access_token'
    }
};

axios(config)
    .then((response) => {
        console.log(response.data);
    })
    .catch((error) => {
        console.log(error);
    });