API Reference

http://localhost:8000/api/

# Public - works without authentication
curl http://localhost:8000/api/zines/
curl http://localhost:8000/api/agents/

# Get token
curl -X POST http://localhost:8000/api/auth/token/ \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "yourpassword"}'

# Returns: {"token": "abc123..."}

# Use token for writes
curl -X POST http://localhost:8000/api/zines/ \
  -H "Authorization: Token abc123..." \
  -H "Content-Type: application/json" \
  -d '{"zine_id": "zine_001", ...}'

GET /api/vocabularies/subjects/
GET /api/vocabularies/genres/
GET /api/vocabularies/agent-kinds/
GET /api/vocabularies/agent-roles/
GET /api/vocabularies/repository-kinds/
GET /api/vocabularies/access-status/
GET /api/vocabularies/rights-status/
GET /api/vocabularies/formats/

GET /api/geography/places/
GET /api/geography/countries/
GET /api/geography/languages/

GET /api/zines/
GET /api/agents/
GET /api/holdings/
GET /api/repositories/

{
  "count": 142,
  "next": "http://localhost:8000/api/zines/?page=2",
  "previous": null,
  "results": [
    {
      "zine_id": "zine_mutate_3_1st",
      "title": "Mutate Zine #3",
      ...
    },
    ...
  ]
}

GET /api/zines/{zine_id}/
GET /api/agents/{agent_id}/
GET /api/holdings/{holding_id}/
GET /api/repositories/{repo_id}/

curl http://localhost:8000/api/zines/zine_mutate_3_1st/

{
  "zine_id": "zine_mutate_3_1st",
  "title": "Mutate Zine #3",
  "creator": [
    {
      "agent_id": "agent_judith_arcana",
      "display_name": "Judith Arcana",
      "kind": "Person"
    }
  ],
  ...
}

POST /api/zines/
POST /api/agents/
POST /api/holdings/
POST /api/repositories/

curl -X POST http://localhost:8000/api/zines/ \
  -H "Authorization: Token YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "zine_id": "zine_mutate_3_1st",
    "title": "Mutate Zine #3",
    "creator": ["agent_judith_arcana"],
    "subject": ["feminism"],
    "genre": ["personal-zine"],
    "date": ["2024"],
    "language": ["en"],
    "rights": ["cc-by-4.0"]
  }'

PUT /api/zines/{zine_id}/       # Replace entire resource
PATCH /api/zines/{zine_id}/     # Update specific fields

curl -X PATCH http://localhost:8000/api/zines/zine_mutate_3_1st/ \
  -H "Authorization: Token YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "abstract": "Updated description",
    "number_of_pages": "36"
  }'

DELETE /api/zines/{zine_id}/
DELETE /api/agents/{agent_id}/
DELETE /api/holdings/{holding_id}/
DELETE /api/repositories/{repo_id}/

curl -X DELETE http://localhost:8000/api/zines/zine_mutate_3_1st/ \
  -H "Authorization: Token YOUR_TOKEN"

# Get zine as JSON-LD
curl -H "Accept: application/ld+json" \
  http://localhost:8000/api/zines/zine_mutate_3_1st/

# Export all zines as CSV
curl -H "Accept: text/csv" \
  http://localhost:8000/api/zines/ > zines.csv

# Get zine as BibTeX
curl -H "Accept: application/x-bibtex" \
  http://localhost:8000/api/zines/zine_mutate_3_1st/

# Zines by subject
GET /api/zines/?subject=feminism

# Zines by genre
GET /api/zines/?genre=personal-zine

# Zines by creator
GET /api/zines/?creator=agent_judith_arcana

# Repositories by country
GET /api/repositories/?country=US

# Holdings by repository
GET /api/holdings/?repository_id=repo_barnard

# Search zines by title/abstract
GET /api/zines/?search=mutate

# Search agents by name
GET /api/agents/?search=arcana

# Sort zines by title
GET /api/zines/?ordering=title

# Sort descending (newest first)
GET /api/zines/?ordering=-created_at

GET /api/zines/?subject=feminism&genre=personal-zine&ordering=-created_at

{
  "count": 142,
  "next": "http://localhost:8000/api/zines/?page=2",
  "previous": null,
  "results": [...]
}

# Page 1 (default)
GET /api/zines/

# Page 2
GET /api/zines/?page=2

# Custom page size (max 100)
GET /api/zines/?page_size=50

GET /api/zines/?page_size=1000000

{
  "title": ["This field is required."],
  "creator": ["This field is required."],
  "subject": ["Invalid subject codes: invalid-code"]
}

{
  "detail": "Authentication credentials were not provided."
}

{
  "detail": "You do not have permission to perform this action."
}

{
  "detail": "Not found."
}

{
  "detail": "Method \"DELETE\" not allowed."
}

{
  "detail": "Internal server error"
}

# settings/production.py
REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES': [
        'rest_framework.throttling.AnonRateThrottle',
        'rest_framework.throttling.UserRateThrottle'
    ],
    'DEFAULT_THROTTLE_RATES': {
        'anon': '100/hour',
        'user': '1000/hour'
    }
}

{
  "detail": "Request was throttled. Expected available in 3600 seconds."
}

# .env
CORS_ALLOWED_ORIGINS=https://yourfrontend.com,https://www.yourfrontend.com

http://localhost:8000/api/
http://localhost:8000/api/zines/
http://localhost:8000/api/agents/

GET /api/schema/