Augur API Overview

The Augur API is a collection of REST microservices. Each service runs at its own subdomain of augur-api.com. Check the service directory for the current list.

Base URL Pattern

https://{service-name}.augur-api.com

Examples:

• https://items.augur-api.com — Product catalog
• https://customers.augur-api.com — Customer data
• https://orders.augur-api.com — Order management

Authentication

All requests require two credentials:

curl -H "Authorization: Bearer YOUR_TOKEN" \
     -H "x-site-id: YOUR_SITE_ID" \
     https://items.augur-api.com/inv-mast?limit=10

Token Types

Tokens are locked to specific sites. Contact SimpleApps to obtain credentials.

Credential Files

The SDK resolves credentials automatically in this order:

1. Environment variables — AUGUR_TOKEN + AUGUR_SITE_ID
2. Explicit file — AUGUR_CREDS_FILE env var pointing to JSON
3. Project file — <cwd>/.simpleapps/augur-api.json
4. Global file — ~/.simpleapps/augur-api.json

Single-site format:

{
  "siteId": "my-site",
  "jwt": "my-token"
}

Multi-site format:

{
  "site-a": { "jwt": "token-a" },
  "site-b": { "jwt": "token-b" }
}

Response Format

All endpoints return a standard JSON envelope:

{
  "status": 200,
  "message": "Ok",
  "data": [],
  "count": 10,
  "total": 10,
  "totalResults": 542,
  "options": {},
  "params": {}
}

Pagination

List endpoints accept limit and offset query parameters:

GET /inv-mast?limit=25&offset=50

API Conventions

• REST only — no GraphQL
• JSON only — no XML
• No breaking changes — new fields are added, old fields are never removed
• Standard HTTP status codes for errors
• No sandbox — test against your configured site
• Rate limits are generous — contact SimpleApps if you hit limits
• Edge caching available — use edgeCache parameter on GET requests

Edge Caching

Any GET request can use Cloudflare edge caching via the edgeCache query parameter:

curl https://items.augur-api.com/inv-mast?limit=10&edgeCache=5m

Implement local caching where appropriate. While Cloudflare handles CDN caching, storing frequently accessed data locally (product catalogs, pricing tiers) reduces API calls and improves response times.