APIs Reference
The IOH APIs allow you to integrate with the IoT Orchestration Hub and automate workflows programmatically.
API Base URL:
https://api.connectedyou.ioFor the complete API reference, visit docs.api.connectedyou.io.
If you have any questions or need assistance, contact our support desk.
Getting Started
To start using the IOH APIs, follow these steps:
Choose an authentication method and generate an access token.
Get your Account ID.
Use the API endpoints with your access token and Account ID.
Authentication
IOH supports two authentication methods:
Username and Password
OAuth 2.0 Client Credentials
Choose the authentication method that best fits your integration.
Tokens are valid for 60 minutes.
Reuse the same access token for all API requests while it is valid. Do not generate a new access token for every API request. Continue using the existing token throughout its 60-minute validity period, and generate a new token only when the current token is expired or approaching expiry. Repeatedly generating tokens for every request is unnecessary and will cause your integration to reach the authentication rate limit.
Authentication Rate Limit
Access-token generation is limited to:
10 requests per minute
This rate limit applies to authentication token-generation requests.
1. Username and Password
The existing authentication flow uses your IOH username and password.
Authentication endpoint
https://api.connectedyou.io/
Use this endpoint to authenticate and obtain an access token.
The access token is valid for 60 minutes. When the token expires, you can authenticate again or use the refresh_token provided in the authentication response, where applicable.
2. OAuth 2.0
IOH also supports OAuth 2.0 Client Credentials for machine-to-machine integrations.
Token endpoint
https://auth.connectedyou.io/oauth2/token
2.1 Create an Auth Client
Before generating an OAuth 2.0 access token, you need to create an Auth Client in the IOH platform.
Navigate to:
Account → Settings → Auth Clients
From the Auth Clients page, you can:
Create a new Auth Client.
Access the credentials required for authentication.
Create and manage multiple Auth Clients for different integrations or applications.
2.2 Required Credentials
The following four parameters are required to generate an OAuth 2.0 access token:
client_id
Available in the IOH platform under the Auth Client.
client_secret
Available in the IOH platform under the Auth Client.
scope
Available in the IOH platform under the Auth Client.
grant_type
client_credentials
Get Your Account ID
After authentication, you need an Account ID to work with the IOH APIs.
Use the following API endpoint to retrieve the accounts available to your user or integration:
https://api.connectedyou.io/v1/users
Select the Account ID that you want to use for your API operations.
Using the APIs
Once you have:
A valid access token
An Account ID
you can start using the IOH APIs.
All available API operations, request parameters, response formats, and examples are documented in the IOH API reference.
API Base URL:
https://api.connectedyou.io/v1
Select an endpoint from the API reference to view its specific requirements and usage.
Quick Reference
Username/Password Auth
https://api.connectedyou.io/
OAuth 2.0 Token Endpoint
https://auth.connectedyou.io/oauth2/token
OAuth 2.0 Grant Type
client_credentials
Access Token Validity
60 minutes
Token Generation Rate Limit
10 requests/minute
Auth Client Location
Account → Settings → Auth Clients
You're now ready to integrate with the IOH APIs.
Last updated
Was this helpful?