Customers can be logged in using offerId or publisherId:

  • offerId - use login with offerId if the customer has already chosen an offer
  • publisherId - use publisherId if you want to enable choosing an offer after login.

Call /auths method to log in the customer.

In response, you will get JWTJWT - JWT (JSON Web Token) - open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed. In Cleeng, JWT payload contains: customerId, publisherId, expiration date. (authorization token) and customerTokencustomerToken - customerToken is used to customer authentication by most of the Cleeng API. Can be used eg. to verify access (getAccessStatus method) (you may need customerToken to use other Cleeng APIs).

Login flowchart

๐Ÿ“˜

Good to know

We recommend using Captcha mechanisms to prevent getting rate limits.

Rate limits are:

  • by default, each method has 200 rps and 50 concurrent requests,
  • login method has 50 rps and 20 concurrent requests,
  • registration method has 20 rps and 10 concurrent requests,
  • reset password method has 10 rps and 5 concurrent requests (because it sends an email).

When reaching the limit, you will get 429 error code. If that happens, wait a few moments to unlock this endpoint.

Updated about a month ago


Login


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.