iCloudReady API Overview

iCloudReady API Overview

Welcome to the iCloudReady API documentation. This guide is designed to provide comprehensive details on how to interact with our API, enabling you to efficiently pull or push data to and from your iCloudReady instance. Our API is accessible across all iCloudReady pricing tiers, including the free option, and is compatible with every on-premise version.

API Features

Our API facilitates robust interactions with the iCloudReady platform, allowing for a wide range of operations, such as:

Data Pushing: Seamlessly send data to your iCloudReady instance, enabling real-time event logging, updates, and more.

Data Retrieval: Extract data from iCloudReady with ease, ensuring your external systems are always in sync with your cloud or on-premise environment.

Authentication

iCloudReady employs basic authentication to ensure secure access to the API. It's crucial to use this method responsibly to protect your account details and the integrity of your data.

Signing In

Authenticate your requests using basic authentication with your iCloudReady credentials. Here’s how you can sign in:

POST /api/v2/signin HTTP/1.1
Host: api.icloud-ready.com
Content-Type: application/json
{ "email": "admin@example.com", "password": "your_password" }

Upon successful authentication, you will receive an access token. Use this token to authenticate subsequent API requests

Using the Access Token

With the received access token, make authorized API calls to iCloudReady. Include the token in the Authorization header as a Bearer token:

GET /api/v2/leads HTTP/1.1
Host: api.icloud-ready.com
Authorization: Bearer your_access_token

Rate limiting

Our API ensures fair usage by implementing rate limits. Here’s what you need to know:

Standard endpoints: 480 requests/minute, 4800 requests/hour.

Resource-intensive endpoints: 240 requests/minute, 1200 requests/hour.

Exceeding these limits might result in temporary suspension of API access. Use our export apps for bulk data retrieval to stay within limits.

Best Practices

Secure Your Credentials: Never expose your password or access tokens.

Manage Your Rate Limits: Design your integration to stay within the prescribed rate limits.

Handle Errors Gracefully: Implement robust error handling to manage API downtime or rate limiting responses effectively.

For detailed endpoint documentation, refer to the subsequent sections of this API guide. If you require assistance or have any questions, please contact our support team at support@icloud-ready.com.