Getting Started
Welcome to the DataSync API documentation. This guide will help you integrate our data synchronization services into your application.
- Sign up for a DataSync API account to receive your API key
- Authenticate your requests using the API key in the Authorization header
- Make requests to our RESTful API endpoints
- Handle responses and implement error handling
Base URL: https://datasync-api.com/api/v1
All API requests require authentication using an API key. Include your API key in the Authorization header of every request.
Headers
| Header |
Description |
Required |
| Authorization |
Bearer token with your API key |
Yes |
| Content-Type |
application/json |
Yes |
Example Request
curl -X GET https://datasync-api.com/api/v1/status \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Health check endpoint to verify API availability and service status. This endpoint does not require authentication.
Response
{
"status": "ok",
"service": "datasync-api",
"version": "1.0.0",
"timestamp": "2024-11-19T20:00:00Z"
}
Example Request
curl https://datasync-api.com/api/v1/health
Get current synchronization status and system operational information. Requires authentication.
Response
{
"status": "operational",
"uptime": "99.9%",
"active_jobs": 1247,
"last_sync": "2024-11-19T19:58:32Z"
}
Example Request
curl -X GET https://datasync-api.com/api/v1/status \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"
Initiate a data synchronization job between source and target systems. Returns a job ID for tracking.
Request Body
| Parameter |
Type |
Description |
Required |
| source |
string |
Source system identifier |
Yes |
| target |
string |
Target system identifier |
Yes |
| options |
object |
Additional synchronization options |
No |
Example Request
curl -X POST https://datasync-api.com/api/v1/sync \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "system1",
"target": "system2",
"options": {
"mode": "incremental",
"priority": "normal"
}
}'
Response
{
"job_id": "sync_abc123xyz",
"status": "queued",
"estimated_completion": "2024-11-19T21:00:00Z"
}
API requests are rate-limited to ensure fair usage and system stability. Rate limits are applied per API key.
Rate Limit Details
- Standard Plan: 1,000 requests per hour
- Professional Plan: 10,000 requests per hour
- Enterprise Plan: Custom limits
Rate limit information is included in response headers: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset