Skip to content

Authentication

All endpoints require a valid application ID and secret. They should be passed as arguments:

  • app: this is the application identification string
  • secret: the application secret string

As these are always required, they will not be listed under endpoint inputs.

Warning

App ID and secret key should be sent as strings. Not sending these will result in an error.

Permissions

API applications operate in the name of their owner (the registrator). All permissions will be inherited from this EduBase account, meaning that an API call will only succeed if that account has proper permissions set. Also, all operations will be registered to this user.

Testing it

It is advised to test basic functionality and correctness of calls before making advanced requests. For this reason, EduBase API service offers a testing endpoint that has no effect on any real data.

curl -d "app={app}&secret={secret}" https://www.edubase.net/api/test:app

Info

If you are developing an integration for a custom EduBase instance, do not forget to replace the domain name!

This should return the following, with HTTP 200 status code:

{"version":"default","app":"{app}","user":"{user}","status":true}

Last update: December 27, 2019