Overview
The Flex5 Rest Api REST API is in early access stage and under heavy development & evolution. This is our "private" Api API that is being built to service our Flex5 Phone, Tablet, & Desktop applications.
It is very likely we will build a "public" Api API layer in the future with something like GraphQL. The reason is that this Rest Api API is pretty low level with a flat JSON structure. This means you will have to make a lot of Api API calls to get all the data that you need.
We envision a more public-friendly Api API in the future that allows external developers to better fetch data in a single request.
...
API Terms & Conditions
Since this Api API is under heavy development & evolution (and could get replaced with a "public" Api API someday), we require that you sign off on an Api API Terms & Conditions document.
...
Accessing Your Own Api Documentation
Our Api API Documentation tool is Swagger UI. You can browse your own Swagger UI by using the template URL below.
...
You can browse the cutting edge ApiAPI's from Flex Dev here: https://flex5dev.flexrentalsolutions.com/f5/swagger-ui.html
...
Writing Your Own Code
When you write your code against the ApiAPI, the process will be similar'ish. You'll have to post to the auth endpoint to get a token and then send it down in the X-Auth-Token header for ALL requests.
If you're token is close to expiring the server will kick out a refresh token in the X-Auth-Token-Refreshed header. Our app just sniffs for the refresh token on each request, and if it finds one, it just replaces the current one and starts sending the new one.
Good luck!