Reference
Server API reference
Authentication, environments and conventions for the Lanying server-side HTTP API used by your backend.
Before calling the API, read api_endpoint, app_id and access-token from the console. app_id and access-token travel in request headers. Unless documented otherwise, the request Content-Type is application/json.
Environments
| Environment | baseUrl |
|---|---|
| Default (hosted) | http://s-1-3-api.maximtop.cn |
| Dedicated / private cloud | The api_endpoint printed by your deployment |
Request headers
POST /app/user/register HTTP/1.1
Host: s-1-3-api.maximtop.cn
app-id: YOUR_APP_ID
access-token: YOUR_ACCESS_TOKEN
Content-Type: application/jsonCapability areas
| Area | What it covers |
|---|---|
| Users | Register, query, update, freeze and delete application users |
| Tokens | Issue per-user tokens for client sign-in |
| Messages | Send system, one-to-one and group messages from the server |
| Conversations | Read history and unread state |
| Groups | Create groups, manage members, admins and announcements |
| Push | Trigger notifications through the configured vendors |
| Files | Upload and sign media used in messages |
The access token is a server secret. Requests from a browser or mobile app must go through your own backend.
Versioning and support
The hosted server API document is versioned v1.0. Technical support is handled through the public issue tracker.