B2Core API REST API The Front Office API Get started

Get started

To get access to the available Front Office API methods, authenticate in the B2Core UI using the methods described below.

Note

If you haven’t yet been registered in the B2Core UI, use the sign up and then sign in methods.

If you have already been registered in the B2Core UI, use the sign in methods.

Sign up

1. Initialize the Sign Up Wizard and get the uuid that is required for signing up to the B2Core UI via the API. To do this, send the following request:

POST[host]/api/v2/my/signup/wizard

Refer to the method to initialize the Sign Up Wizard for details.

2. Sign up to the B2Core UI by sending the following request:

POST[host]/api/v2/my/signup

In the request body, specify the following required parameters:

uuid string required

The universally unique identifier (UUID) obtained at the previous step.

email string required

The client email.

password string required

The client password.

password_confirmation string required

The repeatedly entered password for its confirmation.

device_fingerprint string required

The free-form JSON data (which includes the required user_agent field) generated by a client in the format of a Base64-encoded string that uniquely identifies a device from which a request is sent.

To learn how to get a device fingerprint, refer to Obtain a device fingerprint.

Refer to the method to sign up to the B2Core UI for details.

Sign in

1. Initialize the Sign In Wizard and get the uuid that is required for signing in to the B2Core UI via the API. To do this, send the following request:

   GET[host]/api/v2/my/signin/wizard

Refer to the method to initialize the Sign In Wizard for details.

2. Sign in to the B2Core UI by sending the following request:

POST[host]/api/v2/my/signin

In the request body, specify the following required parameters:

uuid string required

The universally unique identifier (UUID) obtained at the previous step.

email string required

The client email.

password string required

The client password.

device_fingerprint string required

The free-form JSON data (which includes the required user_agent field) generated by a client in the format of a Base64-encoded string that uniquely identifies a device from which a request is sent.

To learn how to get a device fingerprint, refer to Obtain a device fingerprint.

If you have already generated a device fingerprint string when signing up to the B2Core UI, include the one in your sign-in requests.

Refer to the method to sign in to the B2Core UI for details.

After you have successfully signed in to the B2Core UI, you can use the available Front Office API methods to operate the B2Core UI in code.