API Reference

​

Base URL

https://api.boop.network

​

Authentication

curl -X POST https://dev.app.boop.it/api/v1/auth \
  -H "X-API-Key: your-api-key-here" \
  -H "Content-Type: application/json"

​

Interactive API Playground

• Test API calls directly from the documentation
• See request/response examples
• Generate code snippets in multiple languages

​

Available Endpoints

​

Health & Status

• GET /health - Check service health
• GET /api/v1/status - Get system status

​

Authentication

• POST /api/v1/auth/create - Create authentication context
• GET /api/v1/auth//status - Check authentication status
• POST /api/v1/auth//cancel - Cancel authentication

​

User Management

• POST /api/v1/mpc/users/create - Register new user
• POST /api/v1/mpc/users/update - Update user attributes
• POST /api/v1/mpc/users/read - Read user data
• POST /api/v1/mpc/users/delete - Delete user

​

WebSocket Connections

• WS /ws/vendor - Vendor WebSocket connection
• WS /ws/pvs - PVS WebSocket connection

​

Rate Limiting

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200

​

Response Format

​

Success Response

{
  "success": true,
  "data": {
    // Response data
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:00:00Z"
  }
}

​

Error Response

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Invalid request parameters",
    "details": {
      "field": "amount",
      "reason": "Must be a positive integer"
    }
  },
  "meta": {
    "request_id": "req_abc123",
    "timestamp": "2024-01-15T10:00:00Z"
  }
}

​

Error Codes

​

SDK Support

npm install @boop/vendor-sdk

​

Testing

const boop = new BoopClient({
  apiKey: 'sk_test_...',
  baseUrl: 'https://sandbox.boop.network'
});

​

Support