Skip to main content

How to sign up and start using API RuStore

Please log in to gain access to the RuStore API. To do this, generate a key pair - public-private key - in RuStore Console and receive a JWE token.

Create API Keys​

note

To generate keys, you must use the RSA encoding algorithms.

  1. Open RuStore Console.

  2. Go to the "Company" tab in the upper part of the screen (be sure to log in to legal entity account) .

  3. On the left, select "API RuStore".

  4. Click "Generate a key".

img
  1. Enter the key name (up to 255 characters).
img
  1. Select the applications to which the private key will be distributed.
note

You can select one or more apps, or all at once. If you check the box next to “All apps” and then create a new app when generating a key, the key will not apply to it.

  1. Select one or more RuStore API methods. You can choose both application methods the private key will have access to, and general ones. General methods will transfer data from all applications, regardless of which app the key is configured for.

  2. Click "Generate a key".

  3. Once the private key appears in the “Private Key” pop-up window, copy and save it properly. The public key is generated automatically when it is generated and is recorded in the database regardless of the user. To sign in, you only need the value of the generated private key.

info

Key pair generation is available to company owners only. User roles.

If there is a key pair, the created private key will appear in RuStore Console in a table. It indicates the key name and ID, the selected methods and applications, and the key creation or update date.

  1. Open RuStore Console.

  2. Go to the "Company" or "Developer" tab in the upper part of the screen.

  3. In the names section, find the required key.

  4. Click on the action bar.

  5. Then select “Update”.

  6. The public key will be automatically renewed.

You can remove a public and private key in RuStore Console.

  1. Open RuStore Console.

  2. Go to the "Company" or "Developer" tab in the upper part of the screen.

  3. In the names section, find the required key.

  4. Click on the action bar.

  5. Click "Remove".

Receive a token​

Use the generated private key to obtain the JWE token via POST /public/auth/ method.

note

The jwe token is valid for 900 seconds, then it must be obtained again by repeating POST /public/auth/ method.

When signed in​

The resulting JWE token allows you to use the capabilities of the RuStore API. To do this, its value must be transferred to the “Authorization” section using the API-key.