Okos Polip Integration Documentation

Welcome to the Integration Documentation for Okos Polip. Here, you’ll find comprehensive guides and resources to seamlessly integrate our SaaS within your application.

Table of Contents

State API

This section provides an introduction to the State API, detailing its core functionality and how it facilitates real-time state management and monitoring of devices integrated with Okos Polip.

Use Cases

Explore various scenarios where the State API can be effectively utilized, such as real-time monitoring, event-driven automation, and remote device management.

Setup Guide

Step-by-step instructions to get started with the State API, including initial configuration, authentication, and connecting your first device.

API Endpoints

Detailed documentation of all API endpoints, including request and response formats, required parameters, and example requests.


Code examples in multiple programming languages showing how to use the State API to perform common tasks like retrieving device status, updating device settings, and handling real-time alerts.

Best Practices

Guidelines on how to efficiently use the State API, covering aspects such as minimizing latency, handling errors gracefully, and securing communications.


Common issues users might encounter when using the State API, with solutions, troubleshooting steps, and tips for effective problem resolution.

Sensors API (Coming Soon)

A brief introduction to the upcoming Sensors API, outlining its purpose and how it will extend the capabilities of Okos Polip for sensor data integration and analysis.

Planned Features

A list of features that will be available with the Sensors API, such as support for a wide range of sensors, real-time data processing, and integration with analytics platforms.

Anticipated Release Timeline

An estimated timeline for the release of the Sensors API, including key milestones such as beta releases and full availability.

Factory API (Coming Soon)

Welcome to the Factory API Documentation for Okos Polip. This API is essential for businesses and developers looking to automate the device provisioning process and manage device types programmatically. It offers a powerful suite of tools to help you streamline the creation and management of devices without manual intervention through the Okos Polip dashboard.


This section provides a comprehensive introduction to the Factory API, explaining its role, capabilities, and the benefits of integrating it into your device management workflow.

Defining Device Types

Detailed instructions on how to define different types of devices within Okos Polip. This includes setting parameters, specifying capabilities, and customizing settings for various device categories.

Device Provisioning

Guidance on how to provision devices automatically using the Factory API. Topics covered will include:

  • Preparing your system for provisioning
  • Executing batch provisioning commands
  • Managing provisioning errors
  • Examples of provisioning scripts
API Endpoints

A complete reference of all available Factory API endpoints, including detailed descriptions, required and optional parameters, request and response formats, and practical examples for each endpoint to help you understand how to use them effectively.

Use Cases

Illustrative use cases demonstrating the potential of the Factory API in real-world scenarios, such as large-scale deployments, updating device settings en masse, or integrating device provisioning with existing enterprise systems.


Ready-to-use code samples in multiple programming languages to help you quickly implement the Factory API in your projects. These samples will provide practical guidance and reduce the time required to get up and running.


A section dedicated to troubleshooting common issues that may arise while using the Factory API. This includes diagnostics tips, error handling advice, and how to reach out for further support if needed.

Ingest with Okos Polip