The IntegrationOS API lets you create, manage, and monitor data flows between any systems. RESTful, predictable, and built for production.
This guide gets you from zero to a running integration in under 5 minutes. You'll authenticate, create a connector, define a transformation, and execute your first flow.
from integration_platform import IntegrationPlatform # 1. Initialise client client = IntegrationPlatform( api_key="ip_live_YOUR_KEY", tenant_id="your-tenant" ) # 2. Create SFTP connector sftp = client.connectors.create( name="SFTP Production", type="SFTP", config={ "host": "sftp.empresa.pt", "port": 22, "remotePath": "/outbound" }, credentials={ "username": "integrations", "password": "***" } ) # 3. Test connector health health = client.connectors.test(sftp.id) print(f"Connector: {health.status} ({health.latency_ms}ms)") # 4. Create transformation transform = client.transformations.create( name="CSV to Salesforce Contact", source_schema="csv-contact-v1", expression=""" { "FirstName": $substringBefore($.nome_completo, " "), "LastName": $substringAfter($.nome_completo, " "), "Email": $.email, "Phone": $.telefone, "IsActive__c": $.ativo } """ ) # 5. Create integration flow flow = client.integrations.create( name="SFTP → Salesforce Daily Sync", environment="DEV", source_connector_id=sftp.id, target_connector_id="salesforce-prod", transformation_id=transform.id, error_strategy="RETRY_3_DLQ" ) # 6. Test in sandbox result = client.sandbox.execute( integration_id=flow.id, payload={"nome_completo": "João Silva", "email": "j@ex.pt"} ) print(f"Result: {result.status} in {result.duration_ms}ms") print(result.output_payload)
const { IntegrationPlatform } = require('@integration-platform/sdk'); // 1. Initialise client const client = new IntegrationPlatform({ apiKey: 'ip_live_YOUR_KEY', tenantId: 'your-tenant' }); async function main() { // 2. Create SFTP connector const sftp = await client.connectors.create({ name: 'SFTP Production', type: 'SFTP', config: { host: 'sftp.empresa.pt', port: 22 }, credentials: { username: 'integrations', password: '***' } }); // 3. Create integration flow const flow = await client.integrations.create({ name: 'SFTP → Salesforce Daily Sync', environment: 'DEV', sourceConnectorId: sftp.id, targetConnectorId: 'salesforce-prod', expression: `{ "FirstName": $substringBefore($.nome_completo, " "), "Email": $.email }` }); // 4. Test in sandbox const result = await client.sandbox.execute({ integrationId: flow.id, payload: { nome_completo: 'João Silva', email: 'j@ex.pt' } }); console.log(`Result: ${result.status} in ${result.durationMs}ms`); } main();
import com.integrationplatform.sdk.*; public class QuickStart { public static void main(String[] args) { // 1. Initialise client IntegrationPlatformClient client = IntegrationPlatformClient .builder() .apiKey("ip_live_YOUR_KEY") .tenantId("your-tenant") .build(); // 2. Create connector ConnectorDefinition sftp = client.connectors() .create(CreateConnectorRequest.builder() .name("SFTP Production") .type(ConnectorType.SFTP) .config(Map.of("host", "sftp.empresa.pt")) .build()); // 3. Create & deploy integration Integration flow = client.integrations() .create(CreateIntegrationRequest.builder() .name("SFTP → Salesforce") .sourceConnectorId(sftp.getId()) .targetConnectorId("salesforce-prod") .build()); // 4. Run sandbox test SandboxResult result = client.sandbox() .execute(flow.getId(), Map.of("email", "test@ex.pt")); System.out.println("Status: " + result.getStatus()); } }
# 1. Create a connector curl -X POST https://api.integration-platform.io/v1/connectors \ -H "X-API-Key: ip_live_YOUR_KEY" \ -H "X-Tenant-Id: your-tenant" \ -H "Content-Type: application/json" \ -d '{ "name": "SFTP Production", "type": "SFTP", "config": { "host": "sftp.empresa.pt", "port": 22, "remotePath": "/outbound" }, "credentials": { "username": "integrations", "password": "***" } }' # 2. Test connector curl -X POST https://api.integration-platform.io/v1/connectors/CONNECTOR_ID/test \ -H "X-API-Key: ip_live_YOUR_KEY" \ -H "X-Tenant-Id: your-tenant" # 3. Execute in sandbox curl -X POST https://api.integration-platform.io/v1/sandbox/execute \ -H "X-API-Key: ip_live_YOUR_KEY" \ -H "X-Tenant-Id: your-tenant" \ -H "Content-Type: application/json" \ -d '{ "integrationId": "INTEGRATION_ID", "payload": {"email": "test@exemplo.pt"} }'
| Plan | Messages / Month | API Req / Min | Connectors | Retention | SLA |
|---|---|---|---|---|---|
| Free | 10,000 | 60 | 3 | 7 days | Best effort |
| Pro | 500,000 | 300 | 20 | 30 days | 99.9% |
| Enterprise | Unlimited | Custom | Unlimited | Custom | 99.95% |
X-RateLimit-Limit,
X-RateLimit-Remaining,
X-RateLimit-Reset.