Public API

[stephenyeargin]

Wiki documentation: https://github.com/stephenyeargin/seatshare-rails/wiki/Public-API

This is the next phase in building out a potential mobile application or other integrations. Some of the API endpoints may be re-purposed later for a heavier JavaScript-based webapp.

General requirements

• OAuth 2.0 for authorization and security (Provided by Doorkeeper gem?)
• REST-ful API design for developer happiness (Provided by Grape gem?)
• Versioned API for future breaking changes

Assumptions

• Everything will be in the context of a single user
• User will be able to view resources only from groups they belong to
• Edits, updates and deletes will obey same model logic as in web application

Out of scope (for first pass)

• No registration for API application available to end-user (admins only)
• No end-user account registration (web signup only)
• Not concerned with rate limiting at this point
• Ticket assignment is still done through an attribute change (no state machine available yet)