The Editz API allows developers to use Editz's database of corrections to create innovative applications using Editz data. With the API you can read corrections, get grades, and change your corrections status. If you have any questions about the API please contact us and you will receive a quick response.
How to get access to the API:
If this is the first time you access the API you first need to request your token, to do this you need to access the following address after you login:
http://www.editz.com/api/request_token
Here you will be given two token strings, one that will give you access to all the functions of the site using your account and another one that will give you access to some limited functions. The second token is called the public token, because it can be used by anyone.
API Function Reference:
Once you have your token you have all you need to develop an application that uses the API and here is the reference for all the available functions.
All functions are accessed in the following path:
http://api.editz.com/api/FUNC_NAME/USERNAME/TOKEN
Where FUNC_NAME is one of the functions below, USERNAME is your editz username and TOKEN is the token you request or your user password.
Global Parameters:
- method: The output method in which you want to receive the output. This can be one of the following
- nxml: full XML output
- json: JSON output to be used on javascript
- xml: Deprecated. Simplified XML format, use nxml instead, this is here for backward compatibility
- session: Optional. You can use the login function to generate a session ID and use it for all other functions.
- user: Optional. You could prefer to send the user as a parameter if not using the user in the URL or the session parameter.
- token: Optional. If you use the user as a parameter you will need to use the token as a parameter too.