dayjo / api-documentation Goto Github PK

#Create. API Documentation

This is our beta API, which gives you access to the majority of our customers resources within the application. We plan on releasing with most of the planned resources, but some will follow in a later release, this is outlined in the introduction.

This API is not in production

I'm following an RDD style of development, and have only written the documentation before I write any code. If you've been invited to view this documentation, please have a read through and let me know if you see anything that I have missed anything fundimental or if something doesn't make sense. It makes sense for me to get the documentation perfect before I wrote code so that mistakes/improvements can be made early on. This is my first attempt at designing/developing a public API so any feedback is appriciated.

Also, pull requests are welcome.

If you have any questions, you can catch me at the following places:

• Email: [email protected]
• Twitter: @adamstrawson
• Campfire: https://createinternetltd.campfirenow.com/fbba7

For the most recent source, please view gh-pages branch. Revision 1.2 currently being written there.