Developer API Access
Use these endpoints to integrate YS Mail into your workflows.
GitHub Authentication
Required to generate and manage API keys
Endpoints
GET /api/v1/inbox?address=nama@domain.com
GET /api/v1/download?address=nama@domain.com&emailId=uuid&type=email
GET /api/v1/retention
DELETE /api/v1/inbox?address=nama@domain.com&emailId=uuid
Authentication
All API requests require an API key passed in the Authorization header:
# Replace with your API key
curl -H "Authorization: Bearer sk-vm-xxx..." \
https://yourdomain.com/api/inbox?address=user@example.com
curl -H "Authorization: Bearer sk-vm-xxx..." \
https://yourdomain.com/api/inbox?address=user@example.com
Generate an API key above by logging in with GitHub.
Webhook
POST /api/webhook
Use this endpoint to forward inbound emails to your app.
API Tester
Preview request & response untuk endpoint public API. Masukkan API key-mu untuk autentikasi.
# Request
curl -H "Authorization: Bearer vm-xxx..."
/api/v1/inbox?address=nama@domain.com
curl -H "Authorization: Bearer vm-xxx..."
/api/v1/inbox?address=nama@domain.com