Rpc API
REST API reference for rpc.do - Remote Procedure Call (RPC) services
Rpc API
Remote Procedure Call (RPC) services
Endpoint
POST api.do/rpcAuthentication
All API requests require authentication:
curl https://api.do/rpc \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Request
Headers
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
X-Request-ID: unique-request-id (optional)Request Body
{
"operation": "rpc",
"parameters": {
// Operation-specific parameters
},
"options": {
"timeout": 30000,
"retries": 3
}
}Response
Success Response
{
"success": true,
"data": {
// Response data
},
"meta": {
"requestId": "req_123",
"timestamp": "2025-01-01T12:00:00Z",
"duration": 145
}
}Error Response
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid parameters",
"details": {
// Error details
}
},
"meta": {
"requestId": "req_123",
"timestamp": "2025-01-01T12:00:00Z"
}
}Examples
cURL
curl -X POST https://api.do/rpc \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"operation": "rpc",
"parameters": {}
}'JavaScript/TypeScript
const response = await fetch('https://api.do/rpc', {
method: 'POST',
headers: {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({
operation: 'rpc',
parameters: {},
}),
})
const data = await response.json()Python
import requests
response = requests.post(
'https://api.do/rpc',
headers={
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json',
},
json={
'operation': 'rpc',
'parameters': {}
}
)
data = response.json()Rate Limiting
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1609459200Status Codes
200 OK- Success400 Bad Request- Invalid request401 Unauthorized- Missing/invalid API key403 Forbidden- Insufficient permissions404 Not Found- Resource not found429 Too Many Requests- Rate limit exceeded500 Internal Server Error- Server error503 Service Unavailable- Service temporarily unavailable
Error Codes
VALIDATION_ERROR- Invalid parametersAUTHENTICATION_ERROR- Invalid API keyAUTHORIZATION_ERROR- Insufficient permissionsNOT_FOUND- Resource not foundRATE_LIMIT_EXCEEDED- Too many requestsTIMEOUT- Operation timeoutINTERNAL_ERROR- Server error
Webhooks
Subscribe to events:
curl -X POST https://api.do/webhooks \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://your-app.com/webhook",
"events": ["rpc.completed", "rpc.failed"]
}'Best Practices
- API Keys - Store securely, never commit to git
- Error Handling - Handle all error codes gracefully
- Retries - Implement exponential backoff
- Rate Limiting - Respect rate limits
- Idempotency - Use
X-Idempotency-Keyheader - Logging - Log requests for debugging