API Reference
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/users | List all users |
| POST | /api/v1/auth/login | User authentication |
| PUT | /api/v1/users/:id | Update user |
Authentication
API uses JWT tokens for authentication:
$ curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
https://api.example.com/v1/usersRate Limiting
API requests are limited to 100 requests per minute per IP address.
Code Examples
# Ruby example
require 'net/http'
require 'json'
uri = URI('https://api.example.com/v1/users')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_TOKEN'
response = http.request(request)
users = JSON.parse(response.body)