KY MailCloud API Integration

Connect a client wallet, profile, payments, analytics, delivery events, suppressions and support tickets to another portal.

API keys are secrets. Store them only on the integrating portal's server. Never include a key in browser JavaScript, HTML, screenshots, chat messages or URLs.

Discovery

Authentication

  1. Sign in and open API Keys.
  2. Create a dedicated key with only the scopes the other portal needs.
  3. Where practical, restrict it to the other server's public IP address.
  4. 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.

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.