For Developers

Making Requests

This SDK is a wrapper for the Edlink API. It provides an interface for making requests to the Edlink API. Virtually all endpoints require some form of authentication. Please note, there's nothing that you can do with this SDK that you can't also do via an HTTP request to the API, but this SDK contains certain features that we believe will make your life easier.

In order to make most requests with the SDK, you will need a TokenSet. You can read more about how to create one here.

Once you have a TokenSet you can use it to make requests on behalf of a person or an integration. You do this by initializing an instance of the API class and passing the TokenSet with the use() method.

// A User API request
edlink.use(person_token_set).my.profile();

// A Graph API request
edlink.use(integration_token_set).schools.fetch('[...]');

And thats all! You can now make requests on behalf of a person or an integration. Edlink will refresh any person access_token for you if it expires as long as you also provide the refresh_token.