Developers
Merchant API v1
Manage keys in Settings → API after signing in to your merchant dashboard.
Quick start
Base URL https://api.arkvon.com
curl https://api.arkvon.com/v1/me \ -H "Authorization: Bearer YOUR_KEY"
Access
The merchant API is REST for workspaces on an active Boost, Elite, or Founding plan. Trials and Starter do not include API keys. Create keys in Settings → API. The secret is shown once. Authenticate with Authorization: Bearer ak_live_… in production (ak_test_… on non-production).
Security
- Use keys from your server only, never in a browser or mobile app.
- Do not log the Authorization header. Treat keys like passwords.
- Use one key per integration so you can revoke a single system.
- Revoking a key blocks it immediately. Lost keys cannot be recovered.
- Writes are limited to POST accept, reject, and remove for affiliates.
- Dashboard JWTs do not work on /v1, and API keys do not work on dashboard routes.
Limits
60 requests per minute per IP. Up to 10 active keys per workspace. List endpoints default to 20 rows (max 100). Money fields are strings with two decimal places.
Endpoints
- GET
/v1/me: Test that your key works (workspace, key hint, plan) - GET
/v1/campaigns: List all campaigns in your workspace - GET
/v1/campaigns/:campaignSlug: Campaign details - GET
/v1/campaigns/:campaignSlug/overview: Active affiliates, total sales, amount paid, active customers - GET
/v1/campaigns/:campaignSlug/affiliates: Affiliates in a campaign - GET
/v1/campaigns/:campaignSlug/affiliates/:affiliateSlug: One affiliate’s stats and details - POST
/v1/campaigns/:campaignSlug/affiliates/:affiliateSlug/remove: Deactivate an affiliate. Same email and dashboard alert as the UI. - GET
/v1/campaigns/:campaignSlug/join-requests: Pending affiliate requests (pass status to filter) - POST
/v1/campaigns/:campaignSlug/join-requests/:joinRequestSlug/accept: Accept a request. Same emails and dashboard notifications as the UI. - POST
/v1/campaigns/:campaignSlug/join-requests/:joinRequestSlug/reject: Reject a request. No email, same as the dashboard. - GET
/v1/campaigns/:campaignSlug/customers: Referred customers (no IP addresses) - GET
/v1/campaigns/:campaignSlug/commissions: Commission ledger rows - GET
/v1/campaigns/:campaignSlug/payouts: Payout groups for the campaign