simpleapps-com-augur-api 0.9.8

Python client for Augur API microservices

simpleapps-com-augur-api

Python client library for Augur microservices.

Installation

pip install simpleapps-com-augur-api

Quick Start

from augur_api import AugurAPI

api = AugurAPI(
    token="your-bearer-token",
    site_id="your-site-id",
)

# Access any service via api.{service_name}
items = api.items.inv_mast.list(limit=10)
customers = api.customers.customer.list(limit=10)
orders = api.orders.oe_hdr.lookup()

Service Access Pattern

All services are accessed through the unified AugurAPI client:

api.items        # Items service
api.customers    # Customers service
api.orders       # Orders service
api.pricing      # Pricing service
api.commerce     # Commerce service
# ... 27 services total

Documentation

Resource	URL
Full API Reference	https://augur-api.info
Endpoint Hints	https://{service}.augur-api.com/llms.txt
Parameters	https://{service}.augur-api.com/endpoints.jsonl
OpenAPI Spec	https://{service}.augur-api.com/openapi.json

Example: Items Service

• https://items.augur-api.com/llms.txt
• https://items.augur-api.com/endpoints.jsonl
• https://items.augur-api.com/openapi.json

Each llms.txt lists all other available services for discovery.

Authentication

All endpoints require:

• site_id - Site identifier
• token - Bearer authentication token

api = AugurAPI(
    site_id="your-site-id",
    token="your-bearer-token",
)

Configuration

from augur_api import AugurAPI, AugurAPIConfig

# With custom configuration
config = AugurAPIConfig(
    token="your-bearer-token",
    site_id="your-site-id",
    timeout=30.0,
    retries=3,
    retry_delay=1.0,
)
api = AugurAPI.from_config(config)

# From context (for framework integration)
api = AugurAPI.from_context(context)

Edge Caching

Enable Cloudflare edge caching on any GET request using the edge_cache parameter:

# Sub-hour caching
items = api.items.inv_mast.list(limit=10, edge_cache="30s")  # 30 seconds
items = api.items.inv_mast.list(limit=10, edge_cache="1m")   # 1 minute
items = api.items.inv_mast.list(limit=10, edge_cache="5m")   # 5 minutes

# Hourly caching (1, 2, 3, 4, 5, or 8 hours)
items = api.items.inv_mast.list(limit=10, edge_cache=1)      # 1 hour
items = api.items.inv_mast.list(limit=10, edge_cache=8)      # 8 hours

Value	Duration
"30s"	30 seconds
"1m"	1 minute
"5m"	5 minutes
1 - 5, 8	1-5 or 8 hours

The client automatically transforms edge_cache to Cloudflare's cacheSiteId{N} format.

Error Handling

from augur_api import AugurAPI
from augur_api.core.errors import (
    AugurError,
    AuthenticationError,
    NotFoundError,
    RateLimitError,
    ValidationError,
)

api = AugurAPI(token="...", site_id="...")

try:
    response = api.items.inv_mast.get(12345)
except NotFoundError as e:
    print(f"Item not found: {e.message}")
except AuthenticationError as e:
    print(f"Auth failed: {e.message}")
except RateLimitError as e:
    print(f"Rate limited: {e.message}")
except AugurError as e:
    print(f"API error: {e.code} - {e.message}")

For AI Agents

See SKILL.md for guidance on using this package with AI assistance.

License

MIT