Introduction

Welcome to the iPear API docs. This documentation is only for the server side, used to linking your game server and iPear services. Our package @ipear/server (npm) is an example of resource built based on this documentation.

Bugs

If you find a bug with the API or incorrect or out-of-date documentation, you can contact us on our Discord server.

Support

We give technical support on our Discord (create ticket or post in the forums for customers/developers) or email us [email protected]

Before we start

You need a secret key (SECRET) and an endpoint URL (ENDPOINT). These information can be obtained in your customer area > Your project > Your server > "Production mode" option.

Without a server in production mode, you cannot obtain the secret key and the endpoint. Once the production mode is activated, an endpoint and a secret key will be generated for you.

Knowledge requirements

Our API is based on REST principles combined with WebSocket for real-time exchange with the game server.

We use a library based on the websocket: Socket.IO.

It is possible to connect to a Socket.IO server without using a Socket.IO client, but we highly recommend using one of the libraries available for several languages: Socket.IO documentation

Ready?

If you think you are ready, you can start with getting started.