- What do I need to get started with Fiix's API?
- What is an SDK?
- How does my CMMS account affect my access to the API?
- Is the Fiix API available as a RESTful or SOAP web service?
- What is the API usage limit?
- Does Fiix have database connectors?
- What are the key concepts used in Fiix's API?
- What API permissions can I change for the mobile app?
- How do the different User management versions (v5 and v6) affect API?
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 requires access to 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.
Applications that consume our API should be built by developers who understand APIs, JSON, and HTTP. If you are using the Java or JavaScript SDKs, then your developers should be well-versed in these programming languages.
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.
What is an SDK and how can I use it?
SDKs (Software Development Kits) are programming packages that allow developers to build applications for a specific platform.
Fiix has two SDKs available for use: one in Java and one in Javascript. To leverage either of these SDKs to build an application that integrates with Fiix, you will need to:
- Include the SDK according to instructions in the API Reference.
- Set up API keys in your tenant by going to Settings > Connect Management > Fiix API Application Settings > New API Application.
- Configure the SDK with your tenant subdomain and API keys as outlined in the Developer's Guide .
- Begin making requests (see 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.
How does my CMMS account affect my access to the API?
When you generate an API key, it’s associated with the individual user account and the CMMS as a whole. Access to the API inherits both the user’s permissions and the CMMS-wide settings.
Depending on your CMMS version (User Management v5 or v6), API access may be affected. v6 User management calls only have read-only access to the User object, while users in v5 have all create, read, update, and delete actions available. CMMS setups with v6 Work Orders don't have access to v5 Work Orders using API, and setups with v6 Equipment don't have access to v5 Equipment table using API.
Your account permissions also affect what you have access to using the API. For granular control of what data can be accessed via API, customize the account’s permissions (user groups and roles) to match your organization’s needs.
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.
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.
Does Fiix have database connectors?
Fiix does not have database connectors.
What are the key concepts used in Fiix’s API?
Fiix offers two categories of API requests:
- Object requests
- Remote Procedure Calls (RPCs)
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 (RPCs) 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.
What are some use cases for customers using Fiix’s API?
Here are some use cases for 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.)
Which API permissions can I change for the mobile app?
For a list of API permissions you can change, see Mobile App Settings. Some settings may change your ability to access the app, so we recommend proceeding with caution when changing these settings.
How do the different User Management versions (v5 and v6) affect API access?
Your CMMS version affects access to User Management actions using the API.
If your CMMS is using v5 User Management, you have access to all create, read, update, and delete actions listed in the API reference guide.
If you're on v6 User Management, calls to the User object table are read-only. All other API functionalities are the same across both setups. For more information about the differences between v5 and v6 User management, see Compare v5 and v6 User Management.