What you can build
Read public profiles with no registration, or register an application to add RemiliaNET login and call the API.
Each integration below names the client and scopes that it needs. Choose the closest one as your starting point.
Integration types
Each endpoint path is under /api/v1.
The developer portal sets the scopes of a client. A login request sends only
scope=openid. For more information, see App permissions.
Public data without an application
These endpoints need no application registration, no user login, and no access
token. Endpoints outside /api/v1 are website endpoints.
A personal account edits its profile, chats, and plays Beetle on the RemiliaNET website. An application needs its own Login client to log users in or to act for them.
Features of a registered application
An API client reads the directory and global chat without a logged-in user. It cannot read the private account data of a user or send messages as a user, which need a Login client. Each feature also needs its scope on the issued token, so login alone does not enable Beetle or chat access. The scope reference lists the scope and token kind of each endpoint.
To create a client, register an application.
Features without API endpoints
The /api/v1 API has no endpoints for these features:
- Beetle catching, hunting, claims, the faucet, and crafting.
- Live chat updates, reactions, and edits or deletions of messages.
- Chat attachments and messages with attachments.
These features are available only on the RemiliaNET website. A registered API
client or Login client gets no access to them through /api/v1.
