[h1]{PAGETITLE}[/h1]

Engrade's API allows developers to integrate our leading class management tools with school SIS's and partner services. If you would like connect your software to Engrade, please [contact.php contact us] and we'll work with you to bring our tools to your users.

Introduction

Engrade offers a REST API allowing qualified apps to send data to our servers via HTTP POST requests and retrieve data in either XML, JSON, or serialized PHP format. This API is in [b]BETA[/b], so please [contact.php let us know] if something isn't working properly. All posts will be sent to https://api.engrade.com/api/ Input fields will vary depending on the request, but most API requests must have at least 3 fields: [i]apitask[/i] - will determine what data to input or output [i]apikey[/i] - [contact.php contact us for your API key] [i]ses[/i] - will be the session token created by first sending a [_login login request]. Optionally you can specify the format of your output by adding the field [i]api[/i] to your request: [em]api=xml[/em] will return XML (default) [em]api=json[/em] will return JSON [em]api=ser[/em] will return serialized PHP

Technical Overview

[tt]***** Request ***** POST /api/ HTTP/1.1 Host: api.engrade.com Content-length: x apikey=1234&apitask=login&usr=jondoe&pwd=Password123 ***** Response ***** HTTP/1.0 200 OK Date: Sat, 15 Jan 2000 14:37:12 GMT Content-Type: text/xml Content-Length: x <?xml version="1.0" encoding="utf-8" ?> <engrade> <success>true</success> <values> <usr>jondoe</usr> <pwd>Password123</pwd> <ses>9888304868921308840o4h07chple88d7a863c1n724pfa697emf2bfnof3hd11a</ses> </values> <time>1286222925</time> </engrade> [/tt]

Example Successful Request

[tt]***** Request ***** POST /api/ HTTP/1.1 Host: api.engrade.com Content-length: x apikey=1234&apitask=login&usr=jondoe&pwd=WrongPassword ***** Response ***** HTTP/1.0 200 OK Date: Sat, 15 Jan 2000 14:37:12 GMT Content-Type: text/xml Content-Length: x <?xml version="1.0" encoding="utf-8" ?> <engrade> <success>[b]false[/b]</success> <values> <usr>teacher</usr> <pwd>WrongPassword</pwd> </values> <errors> <pwd>[b]Invalid password[/b]</pwd> </errors> <time>1286229374</time> </engrade>[/tt]

Example Failed Request