Custom API

A comprehensive API for Affonso that would allow program owners to programmatically access and manage their affiliate programs

Proposed API Endpoints

Affiliates

• GET /api/v1/affiliates - List all affiliates with filtering options

• GET /api/v1/affiliates/{id} - Get detailed information about a specific affiliate

• POST /api/v1/affiliates - Create a new affiliate

• PUT /api/v1/affiliates/{id} - Update an affiliate's information

• DELETE /api/v1/affiliates/{id} - Deactivate/remove an affiliate

Referrals

• GET /api/v1/referrals - Get all referral records with filtering

• GET /api/v1/referrals/{id} - Get details for a specific referral

• GET /api/v1/affiliates/{id}/referrals - Get all referrals from a specific affiliate

Sales/Conversions

• GET /api/v1/sales - Get all sales data with filtering options

• GET /api/v1/sales/{id} - Get detailed information about a specific sale

• GET /api/v1/affiliates/{id}/sales - Get all sales from a specific affiliate

Commissions

• GET /api/v1/commissions - List all commissions

• GET /api/v1/commissions/{id} - Get details for a specific commission

• PUT /api/v1/commissions/{id} - Update commission status (approve/reject)

• GET /api/v1/affiliates/{id}/commissions - Get all commissions for a specific affiliate

Payouts

• GET /api/v1/payouts - List all payouts

• GET /api/v1/payouts/{id} - Get details for a specific payout

• POST /api/v1/payouts - Create a new payout

• GET /api/v1/affiliates/{id}/payouts - Get all payouts for a specific affiliate

How would you use this?

I'd love to hear your use cases, but here are some ideas:

1. Integration with existing systems: Connect Affonso data with your Payment provider, MoR, CRM, accounting software, and business intelligence tools

2. Custom reporting: Build tailored reports beyond what's available in the dashboard

3. Automation: Create workflows that respond to affiliate activities

4. Mobile app development: Build a custom mobile experience for your affiliates

5. In-App Referral Program

Questions for you

• What other endpoints would you need?

• Which of these would be most valuable to you?

• Would you prefer GraphQL instead of REST?

• Any specific authentication methods you'd prefer?

Vote and comment

Please upvote this request if you'd find an API valuable, and share how you'd use it in the comments below!