Skip to content
tlanclos edited this page Oct 14, 2015 · 4 revisions

Functional Requirements

  • The API must implement authentication via a set of Techneaux-provided company credentials which will consist of a username and password. No other part of the API will allow access until authentication has occurred.
  • The API must provide a universally unique identifier to act as a session key in the response of a successful authentication request.
  • The API must provide an interface to store additional user information in the database including company name, employee name, phone number, and email address. Each set of information will be associated with the uuid for that user.
  • The API must provide an interface that accepts an image (encoding, filetype, and resolution/size restrictions TBD), a description, and optionally a location/site and stores this data in the Techneaux ticket database.
  • Every request must be secured via SSL.
  • The API should accept unicode characters.
  • A user will not be able to logout without uninstalling the application

Non-Functional Requirements

  • The API web server must be compatible with Ubuntu (Linux)
  • There should be a limit on the image size (either resolution or memory size)
  • The API could limit login requests on a set timeframe to prevent brute-force hacks
  • The webserver could use nginix instead of apache

Clone this wiki locally