Getting Started
Welcome to the Yanki Automations API! Our RESTful API allows you to integrate industrial-grade AI automation into your enterprise systems and workflows.
Base URL
https://api.yanki.co.in/v1
Quick Start
Get your automation platform running in minutes:
- Sign up for a Yanki Automations enterprise account
- Generate an API key from your enterprise dashboard
- Configure your first automation workflow
- Deploy and monitor your automation agents
Authentication
Yanki Automations uses enterprise-grade API keys for authentication. Include your API key in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api.yanki.co.in/v1/automations
API Key Management
- Generate: Create new API keys in your enterprise dashboard
- Rotate: Regularly rotate keys for enhanced security
- Scope: Limit key permissions by automation suite and resource type
- Monitor: Track API key usage, rate limits, and security events
Automation API
Create and manage AI-powered automation workflows across your enterprise operations.
Create an Automation Workflow
POST /v1/automations
{
"name": "HR Onboarding Automation",
"description": "Automated employee onboarding process",
"suite": "enterprise_ops",
"type": "hr_workflow",
"config": {
"triggers": ["new_employee_added"],
"actions": [
"create_accounts",
"assign_equipment",
"schedule_training"
],
"approvals_required": true,
"timeout_hours": 24
}
}
List Automation Workflows
GET /v1/automations
Response:
{
"automations": [
{
"id": "auto_123",
"name": "HR Onboarding Automation",
"status": "active",
"suite": "enterprise_ops",
"created_at": "2025-01-10T10:00:00Z",
"last_executed": "2025-01-11T09:15:00Z"
}
]
}
Execute Automation
POST /v1/automations/auto_123/execute
{
"input_data": {
"employee_id": "EMP001",
"department": "Engineering",
"start_date": "2025-01-15",
"manager_email": "manager@company.com"
},
"priority": "high",
"callback_url": "https://your-system.com/webhooks/automation-complete"
}
IoT & Plant API
Connect and manage industrial IoT devices, sensors, and plant equipment.
Register IoT Device
POST /v1/iot/devices
{
"device_id": "SENSOR_001",
"name": "Production Line Temperature Sensor",
"type": "temperature_sensor",
"location": {
"plant": "Manufacturing Plant A",
"line": "Production Line 1",
"coordinates": {"x": 100, "y": 200}
},
"config": {
"sampling_rate": 5,
"alert_thresholds": {
"min": 18,
"max": 85
}
}
}
Stream Sensor Data
POST /v1/iot/devices/SENSOR_001/data
{
"timestamp": "2025-01-11T10:30:00Z",
"readings": {
"temperature": 72.5,
"humidity": 45.2,
"pressure": 1013.25
},
"quality": "good",
"device_status": "online"
}
Get Predictive Maintenance Insights
GET /v1/iot/devices/SENSOR_001/predictions
Response:
{
"device_id": "SENSOR_001",
"predictions": {
"failure_probability": 0.15,
"estimated_remaining_life": "45 days",
"recommended_actions": [
"Schedule calibration check",
"Monitor vibration levels"
]
},
"confidence": 0.92
}
Webhooks
Receive real-time notifications about automation events and system status changes.
Webhook Events
- automation.completed: Automation workflow finished successfully
- automation.failed: Automation workflow encountered an error
- iot.alert: IoT device triggered an alert condition
- system.maintenance: Scheduled maintenance or system updates
- compliance.violation: Compliance rule violation detected
Webhook Payload
{
"event": "automation.completed",
"timestamp": "2025-01-11T10:30:00Z",
"data": {
"automation_id": "auto_123",
"execution_id": "exec_456",
"status": "completed",
"duration_seconds": 1847,
"result": {
"employees_processed": 5,
"accounts_created": 5,
"equipment_assigned": 5
}
}
}
SDKs and Libraries
Use our official SDKs to integrate Yanki Automations into your enterprise applications.
Python SDK
pip install yanki-automations
from yanki_automations import YankiClient
client = YankiClient(api_key="your_key")
automation = client.automations.create(
name="Finance Automation",
suite="enterprise_ops",
type="finance_workflow"
)
Node.js SDK
npm install @yanki/automations-sdk
const { YankiClient } = require('@yanki/automations-sdk');
const client = new YankiClient({
apiKey: 'your_key'
});
const automation = await client.automations.create({
name: 'Supply Chain Automation',
suite: 'industrial_iot'
});
Available SDKs
- Python: Full-featured SDK with async support and industrial protocols
- Node.js: TypeScript definitions and enterprise integrations
- Java: Enterprise-ready with Spring Boot and Maven support
- C#/.NET: Windows and Azure integration capabilities
- Go: High-performance SDK for microservices and edge computing
- REST API: Direct HTTP calls for any programming language
Enterprise Features
Rate Limits
API rate limits by enterprise plan:
- Starter: 5,000 requests/hour
- Growth: 50,000 requests/hour
- Enterprise Deployment: Custom limits and dedicated infrastructure
Data Residency & Compliance
- Regional Deployment: Choose data processing regions
- Compliance: GDPR, HIPAA, SOC 2, ISO 27001 certified
- Audit Logs: Comprehensive API usage and data access logs
- Encryption: End-to-end encryption for all API communications
Error Handling
The API uses conventional HTTP response codes:
- 200: Success - Request completed successfully
- 400: Bad Request - Invalid parameters or request format
- 401: Unauthorized - Invalid or missing API key
- 403: Forbidden - Insufficient permissions for resource
- 429: Too Many Requests - Rate limit exceeded
- 500: Internal Server Error - System error occurred
Support & Resources
Need Technical Support?
Our developer support team is available to help with integration challenges and technical questions.