Cancer Delta API Documentation

Welcome to the Cancer Delta API documentation. This API serves content data from our Neon database, providing access to articles, resource categories, spaces, and assets.

API Endpoints

Content Endpoints

Articles

• GET /api/articles - Get paginated article list

  Parameters:

  • limit: Number of articles to return (default: 10)
  • page: Page number (default: 1)
  • resource_space_id: Optional filter for articles related to a resource space
  • tag_id: Optional filter for articles with a specific tag
  • category: Optional filter for articles in a specific category
• GET /api/article/[slug] - Get a single article by slug

  Returns article metadata, content, and associated tags

Tags

• GET /api/tags - Get all tags

  Parameters:

  • resource_space_id: Optional filter for tags associated with a specific resource space

  Returns a list of all tags or tags filtered by resource space

Resources

• GET /api/resource-categories - Get all resource categories
• GET /api/resource-classes - Get resource classes

  Parameters:

  • category_id: Optional filter for classes in a specific category
• GET /api/resource-spaces - Get resource spaces

  Parameters:

  • class_id: Optional filter for spaces in a specific class
  • category_id: Optional filter for spaces in a specific category
• GET /api/resource-spaces/[slug] - Get a single resource space by slug
• GET /api/resource-assets - Get resource assets

  Parameters:

  • space_id: Optional filter for assets in a specific space
  • type: Optional filter for assets of a specific type
  • section: Optional filter for assets in a specific section
• GET /api/resource-assets/[id] - Get a single resource asset by ID

Authenticated Endpoints

These endpoints require a valid JWT token in the Authorization header.

• GET /api/bookmarks - Get user's bookmarked articles
• GET /api/user/tracked-items - Get user's tracked resources

Authentication

Protected endpoints require a JWT token in the Authorization header:

Authorization: Bearer YOUR_JWT_TOKEN

The JWT token is validated against the secret defined in your environment variables. User authentication is managed through Supabase, while content data is served from Neon.

Response Format

All API responses follow a consistent JSON format:

{"articles": [...],"categories": [...],"tags": [...],"page": 1, "limit": 10, "hasMore": true}

Caching

Content endpoints use appropriate Cache-Control headers:

• Public content: public, s-maxage=60, stale-while-revalidate=3600
• User-specific content: private, no-cache

Error Handling

API errors return appropriate HTTP status codes with a JSON response:

{"error": "Error message description"}

Rate Limiting

The API implements basic rate limiting. Please ensure your application handles 429 responses appropriately by implementing backoff strategies.

CORS

The API supports CORS for the origins specified in the CORS_ORIGIN environment variable. By default, this includes localhost development environments and the Cancer Delta app domain.