The External API feature of the IOK Platform enables you to integrate your equipment, menus, recipes, and operational data with external systems, ERPs, dashboards, proprietary applications, BI platforms, and other solutions developed by your company.

With it, you can automate processes, consume platform data in real time, and even connect equipment directly via API, depending on operational needs.

Prerequisites

Before using the API features, you must:

1. Have an active account on the IOK Platform.
2. Be linked to a company on the platform.
3. Have access to the equipment and menus you wish to use

If you do not yet have access:

• Learn how to create an account:
  IOK Platform - Login Tab
• Learn how to invite users to an existing company:
  IOK Platform - Users Tab

Important Recommendation

To make the most of the API features, we recommend that your account already has:

• Registered equipment
• Created menus
• Configured groups and recipes

Related articles:

• Equipment:
  IOK Platform - Equipment Tab
• Menus:
  IOK Platform - My Menus Tab

Note:
It is also possible to connect equipment directly to the IOK Platform using the API itself.

How to Enable Developer Mode and Generate the Token

After logging into the IOK Platform:

1. Click your username in the top right corner
2. Select the "Edit Account" option
3. Click on "Developer Token"

A window will appear requesting your current platform password.

4. Enter your password
5. Click "Confirm"

After confirmation, Developer Mode will be enabled and a Developer Token will be generated.

Important:
This token is used to authenticate requests made via the API. We recommend keeping it secure and not sharing it with third parties.

Copying the Developer Token

After generation:

1. Copy the token displayed on the screen
2. Use this token to authenticate API requests

This token must be sent in the headers of calls made to the platform’s endpoints.

Accessing the API Documentation

After enabling Developer Mode, a new option called "External API" will appear in the IOK Platform’s side menu.

By accessing this option, you will be directed to the interactive API documentation.

On this page, you can:

• View all available endpoints
• Understand the parameters of each request
• Consult payload examples
• Test requests directly through the browser
• Validate integrations before final implementation

How to Authenticate Requests

In the API documentation:

1. Click the "Authorize" button
2. Enter the Developer Token
3. Confirm the authentication

After this, requests made within the documentation will automatically use the provided token.

Querying Connected Equipment

If you want to work with data from equipment connected to your account, the endpoint below is one of the most important:

GET /equipmentList

It returns the list of equipment linked to the company, including their respective IDs.

Equipment IDs are used in various API endpoints.

How to Find an Equipment ID

Besides the endpoint GET /equipmentList, you can also find the ID directly on the platform:

1. Go to the "Equipment" tab
2. Select the desired equipment
3. Open the individual equipment dashboard

The ID will be displayed in the equipment information.

Examples of API Usage

With the IOK Platform’s External API, your company can:

• Integrate equipment with proprietary systems
• Automate sending menus and recipes
• Develop custom dashboards
• Create integrations with ERPs and CRMs
• Monitor telemetry and events
• Automate software updates
• Consolidate operational data in BI tools
• Develop custom applications for operations

Important Notes

• Each token has a request limit per minute
• The token is individual and linked to the user account
• We recommend that integrations be developed by technology professionals
• Some features may vary depending on the equipment model

Need Help?

If you have questions about integrations or using the IOK Platform’s External API, please contact our support team through Prática’s official support channels.