Getting started

Retrieve your credentials

Go to https://customer.ipear.fr

  • Create your account or login.
  • Create a project.
  • Add a server in this project and provide some information about it.
  • Purchase a license (skip this step if you already have one).
  • Once done, link the previously purchased license to your server by editing it.
  • Enable "Production Mode" unlocked by the license.
  • Retrieve your SECRET KEY and your ENDPOINT URL.

If you want to refresh your SECRET KEY, you can disable/enable the production mode. It will give you new credentials.

Reference

DataDescription
SECRET KEYUnique key used for authentication
ENDPOINT URLAPI URL to use for this server with version

Available API version

You can choose your ENDPOINT version when you create an instance of iPearServer object.

Current version: /v1

Inside your NodeJS project

Install our package:

npm i @ipear/server

Once installed, you can initialize an instance:

const app = new iPearServer({
    secretKey: "MY_SECRET_KEY",
    endpoint: "https://ENDPOINT.URL"
});

Available options here.

Next

Start by creating your first player

Powered by Doctave