Incentives API

The Incentives API provides endpoints to the Sky Rewards Program data (integration boost incentives and accessibility rewards)

Overview

Incentives API provides:

• Sky’s Integration boost incentives endpoints
• Sky’s Accessibility rewards incentives endpoints
• Auth endpoints for token generation

Technical Details

API Specifications

• Type: RESTful API
• Framework: TBD
• Database: TBD
• Hosting: Vercel

Authentication & Authorization

API Authentication (not implemented yet)

• Method: TBD (API keys, OAuth, JWT)
• Rate Limiting: TBD
• Access Levels: TBD

Security

• HTTPS enforcement
• API versioning (?)

Deployment

Environments

• Production: https://api.cambria.cx/

Hosting & Infrastructure

• Provider: Vercel
• SSL/TLS: Vercel

Data Management

Integration Boost Incentives Data

• Calculation cron job
• Format data
• Persist results (buffer) in mongodb database
• Expose data at the following endpoints:
  • https://api.cambria.cx/api/integration-boost/week-ranges
  • https://api.cambria.cx/api/integration-boost/week-ranges/[partnerName]

Accessibility Rewards Data

• Calculation cron job
• Format data
• Persist results (buffer) in mongodb database
• Expose data at the following endpoints:
  • https://api.cambria.cx/api/accessibility-rewards/summary-by-month/[farmName]

Monitoring & Performance

API Metrics

• TBD

Monitoring Tools

• API monitoring: Vercel
• Error tracking: Vercel
• Performance dashboards: TBD

Documentation

API Documentation

• Swagger API Docs

Contact Support

• Phin (0x_phiny)
• Pixel Rover (cristiangavrilita)