1. What do I need to get started with Fiix’s API?
The Fiix API is available to customers who are subscribed to Fiix’s Enterprise Plan. If you are not currently subscribed to Fiix’s Enterprise Plan, an upgrade to this plan will be required.
The Fiix API is a cloud-based service, meaning it is accessible over the internet. Any consuming application must be able to communicate with our API over HTTPS. Any programming language that can send and receive JSON over HTTPS can be used to consume our API.
While Fiix can assist in answering questions related to the objects and functions accessible via the Fiix API, we do not offer troubleshooting, UAT, or other support related to any applications ingesting the Fiix API.
2. What is an SDK and how can I use it?
SDK is the acronym for “software development kit”, which is a programming package that enables a developer to build applications for a specific platform.
a) Include the SDK according to instructions in the API Reference.
b) Set up API keys in your tenant by going to:
Settings > Connect Management > Fiix API Application Settings > New API Application
c) Configure the SDK with your tenant subdomain and API keys as outlined in the Developer's Guide.
d) Begin making requests as outlined in the Developer's Guide.
For all other programming languages, the API can be consumed directly as outlined in the guide on how to use our API without an SDK.
3. Is the Fiix API available as a RESTful or SOAP web service?
The Fiix API is not available as a RESTful or SOAP web service.
4. What is the API usage limit?
Each account has a limit of 1,000 API calls per day, per user license. For example, an account that has purchased 10 user licenses will have a limit of 10,000 API calls per day.
5. Does Fiix have database connectors?
Fiix does not have database connectors.
6. What are the key concepts used in Fiix’s API?
Fiix offers two categories of API requests:
- Object Requests
- Remote Procedure Calls.
Resource calls are CRUD interactions with specific Objects. CRUD stands for Create, Read, Update and Delete. Objects are specific things in Fiix, such as Work Orders, Assets, Tasks, etc. The API can be used to read or modify most objects in the application. For a list of all objects available via the API, see the API Reference documentation.
Remote Procedure Calls are commonly referred to as RPCs. These are useful when complicated interactions with multiple Resources are needed to effect a conceptual operation. For a list of all RPC calls available via the API, see the API Reference documentation.
7. What are some use cases for customers using Fiix’s API?
Here is a sampling of use cases that our customers have developed solutions for using the Fiix API:
- Sending regular meter readings for an asset into Fiix
- Automate the process of updating an asset’s online or offline status in Fiix
- Export the Parts and Supplies inventory from your ERP system into Fiix
- Create work orders based on abnormal operating conditions from your monitoring systems (e.g. manufacturing execution system, machine sensors etc.)