Evercycle API Documentation
Welcome to the comprehensive documentation for the Evercycle API project. This documentation covers every module, function, API endpoint, operational flow, and provides executable examples for all transactions.
Contents:
- Project Overview
- Architecture
- API Endpoints
- Operational Flows
- Flow 1: Authenticate and Store Tokens
- Flow 2: Call a Protected API with Valid Token
- Flow 3: Call an API with Expired Token (Auto-Refresh)
- Flow 4: Get Asset by ID (Runtime Path Patching)
- Flow 5: Create a New Asset
- Flow 6: Edit Asset (PUT with Path Parameter)
- Flow 7: Grade Update (PUT with Multiple Path Parameters)
- Flow 8: CLI Auth and Config Generation
- Flow 9: Interactive Menu Runner
- Module Reference
- Examples
- Example 1: Authenticate via curl
- Example 2: List available APIs
- Example 3: Get all assets (paginated)
- Example 4: Get asset by ID
- Example 5: Create a new asset
- Example 6: Edit an asset
- Example 7: Update grade price
- Example 8: CLI usage — generate configs
- Example 9: CLI usage — authenticate and run an API
- Example 10: Python programmatic usage
- Agent Maintenance Guide