REST API Reference

Welcome to the AcmeAPI v2.0 documentation. This API provides programmatic access to Acme's core platform services. All endpoints return JSON responses and require authentication via Bearer token.

Authentication

Include your API key in the Authorization header:

Authorization: Bearer sk_live_xxxxxxxxxxxxx

Keys are scoped to specific permissions. See the Authentication guide for details on managing keys.

Rate Limiting

API requests are rate-limited per key. Current limits are published in the X-RateLimit-* response headers. Exceeding your limit returns a 429 Too Many Requests response.

Endpoints

List Users

Create User

{
  "email": "user@example.com",
  "name": "Jane Smith",
  "role": "developer"
}

List Products

Error Handling

Errors are returned as JSON with the following structure:

{
  "error": {
    "code": "invalid_request",
    "message": "A human-readable description",
    "request_id": "req_abc123"
  }
}

Pagination

List endpoints use cursor-based pagination. Responses include a next_cursor field when additional results are available.

Webhooks

Webhooks notify your server when events occur. Configure endpoints in the Dashboard. Delivery is retried up to 3 times with exponential backoff.