Platform API¶
The Platform API is the programmatic interface to the Yappes enterprise platform. Use it to automate workflows, integrate Yappes with external systems, and manage platform resources without using the Admin Console or API Manager UI.
Typical use cases include provisioning organizations, onboarding users, listing API proxies, configuring rate plans, managing user applications, and handling wallet transactions.
Authentication¶
The Platform API uses API key authentication. Every request must include a valid key in the x-yappes-key request header:
x-yappes-key: <your-platform-api-key>
How to obtain an API key¶
- Sign in to the Admin Console.
- Open Developer Settings → API Keys.
- Click Create API Key, set a name and expiration, then copy the key when it is shown (full key material is displayed only once).
For detailed steps, see API Keys.
Getting started¶
- Create a API key in Developer Settings.
- Choose an Platform API below and open its reference page.
- Send a request with your key in the
x-yappes-keyheader and the documented HTTP method, path, and body.
Responses are JSON unless noted otherwise on a specific endpoint page.
Available Platform APIs¶
Each section below is a separate reference. Open a card to view endpoints, request and response shapes, and error codes.
Organization
Create organizations, configure monetization add-ons, run gateway analytics queries, and list partner organizations.
User
Invite users, fetch profiles, enable or disable accounts, and configure prepaid or postpaid billing.
Proxy
List all API proxies for an organization or fetch a specific proxy by name, including endpoints and metadata.
Rate Plans
Create rate plans for API products with recurring and consumption pricing.
User App
Create user apps, approve or revoke subscriptions, and fetch app details and credentials.
Wallet Transaction
Credit user wallet balance and list wallet recharge transaction history.