KY MailCloud API Integration
Connect a client wallet, profile, payments, analytics, delivery events, suppressions and support tickets to another portal.
Discovery
- API base:
https://mailcloud.ky-sms.com/api/v1 - OpenAPI:
/api/openapi.json - Integration manifest:
/.well-known/integration.json
Authentication
- Sign in and open API Keys.
- Create a dedicated key with only the scopes the other portal needs.
- Where practical, restrict it to the other server's public IP address.
- Copy it once and store it as a server environment variable.
Authorization: Bearer YOUR_API_KEY
Accept: application/json
Wallet example
curl "https://mailcloud.ky-sms.com/api/v1/balance.php" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
The wallet endpoint requires balance.read and returns currency, wallet status, balance, current email price and estimated email credits.
SMS and e-Certificate placeholders
The contracts below are published so another portal can prepare its integration. SMS delivery and certificate issuance are not operational yet.
GET https://mailcloud.ky-sms.com/api/v1/sms/status.php— requiressms.read.POST https://mailcloud.ky-sms.com/api/v1/sms/send.php— requiressms.sendand currently returns HTTP 503.GET https://mailcloud.ky-sms.com/api/v1/certificates/status.php— requirescertificates.read.POST https://mailcloud.ky-sms.com/api/v1/certificates/issue.php— requirescertificates.issueand currently returns HTTP 503.
Placeholder action calls never debit the wallet, queue SMS messages, or create certificates.
Available scopes
profile.read, balance.read, api_logs.read, suppressions.read, delivery_events.read, analytics.read, tracking_events.read, payments.read, support.read, support.write, sms.read, sms.send, certificates.read and certificates.issue.
For coding agents
Read the OpenAPI document above for production endpoints, methods, parameters, bodies, scopes and response formats. Ask the owner for a restricted API key through a secure channel; this public documentation intentionally contains no credentials.