Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

It is very likely we will build a "public" API layer in the future with something like GraphQL. The reason is that this REST API is pretty low-level, with a flat JSON structure. This means you will have to make a lot of individual API calls to gather all the data you need.

...

Since this API is under heavy development & evolution (and could get replaced with a "public" API someday), we require that you sign off on an API Terms & Conditions document.You ; you can find it here: https://docs.google.com/document/d/18m-saxs5foVA0JLp9N_7fmVEqFG1c1spZw8OC9wLEYs/edit

Download that document, fill it in, sign , and send to flex5api@flexrentalsolutions.com. Once it's received, you will be provided it, then go here to complete a request form. Once the request is received, we will review it, and if approved, we will provide you with a special "source" property you will need which is needed to get authentication tokens.

...

You can download the entire Swagger API definition by right-clicking the link below Api API Documentation (near the top of the screen) and using your browser's "Save As" feature. The link should look like https://yourflexsite.flexrentalsolutions.com/f5/api/api-docs.

...

The JSON should look something like the below. Notice the special "source" property, that which is a special "key" that prevents unauthorized access to the API.

...

Note: you will need to repeat this process for your own URL. Also, note that your Flex site will only show the currently available public APIs which will differ from the flex5dev offerings.

...