API Reference

Detailed documentation for the Acme Corp API.

Authentication

API Key

All requests require a valid API key. You can obtain your API key from the Account Settings page.


X-API-Key: YOUR_API_KEY
            

Endpoints

Get User Profile

Retrieve user profile information.


GET /users/{user_id}

Example Response:


{
    "id": 123,
    "username": "john.doe",
    "email": "john.doe@example.com"
}

Create New Resource

Create a new resource in the system.


POST /resources
Content-Type: application/json
{
    "name": "New Resource",
    "description": "A description of the resource.",
    "category": "Example"
}

Success Response (201):


{
    "id": 456,
    "name": "New Resource",
    "description": "A description of the resource.",
    "category": "Example"
}

Search Resources

Search for resources based on various criteria.


GET /resources?query=keyword&category=Example