BEE Plugin application authorization

Client ID and Client Secret

BEE Plugin allows you to embed the BEE email and landing page editor within a software application.

In this article, when we say "application", we mean the client application that is hosting the BEE editor. That is, the software application into which the BEE editor in being embedded by using BEE Plugin.

The BEE Plugin system uses OAuth2 as the authorization framework.

When you initialize an instance of BEE Plugin within the application, you are required to authenticate who that application is by passing the application's:

  • client_id
  • client_secret

If you have not already done so, you can obtain your Client ID and Client Secret by creating a new application in the BEE Plugin developer portal.

Access Token

If the authentication is successful, the BEE Plugin authorization service will return a temporary access token to the client application. The token can then be used by the client application to start communicating with the BEE Plugin resource server.

The token has a duration of one minute after which it expires, for security reasons. An expired token can be refreshed for 30 minutes without re-authenticating the application.

Token Refresh

Once the application has started communicating with the BEE Plugin resource server, the plugin will take care of refreshing the token automatically as long as someone is actively using the editor, and for 20 minutes during inactivity.

401 Authorization Errors

If a token has expired, the plugin receives a 401 error and attempts to refresh it automatically. The 401 errors are nothing to worry about as they are part of this process.

In the screenshot below, for example, you will notice:

  1. A call to the HTML parser, one of the services provided by the system
  2. The call does not go through because the token has expired (401 status)
  3. BEE Plugin therefore calls the authorization service to refresh the token
  4. It then performs the same call to the HTML parser, and this time the call is successful (200 status).

401_error_bee_plugin.png

Related articles

Have more questions? Submit a request

Comments