Basic API Principles

The FrankieOne API is based on the standard RESTful principles of passing JSON based payloads over HTTPS to endpoints that represent objects and actions.

We’ve aimed to keep the API as simple and as flexible as possible.

Simple in that we’ve tried to not over-complicate things with HTTP verbs, sticking to the basics:

  • GET for retrieving data
  • POST for adding/updating (rather than using combinations of PUT, POST and PATCH)
  • DELETE for deleting data

Flexible in that we tried to not enforce a single, specific flow upon the user, rather we allow you to create your own flows, and the API will do its best to accommodate you. This means you can maintain control of your end-user experience.