How integration activation works via the Marketplace #
- The user clicks Connect on your app page in the Altegio Marketplace.
- Altegio asks the user to grant API access to their Altegio account. After that, the integration can be activated via an API request from your side.
- From Altegio, the user will be redirected to the registration form URL of your service that you specified in the app settings in the Registration redirect url field.
A GET parameter salon_id will be added to your registration form URL. The value of this parameter is the location identifier in Altegio and the CRM token from Telephony > Integration in the client’s chain. You will need to activate the app using this salon_id.
Additionally, salon_group_id will also be passed — this is the chain ID that the branches belong to. This parameter helps with additional client identification.
- After the user completes registration/authorization in your service, you must send an API request to activate the integration.
IMPORTANT
You must send the activation request within 1 hour after the user grants access to their Altegio account (i.e., after they are redirected to your registration page). If you send the request later, you will receive an error, and the user will need to activate the integration again via the Marketplace.
After you send the API activation request, the integration with your service will be connected in the Altegio location account: events about changes in the branch will start being sent to the webhook URLs you provided.
- Along with sending the Marketplace app activation request, you will also need to send an API request to enable telephony for the client using the old protocol.
- Implement the remaining telephony methods: saving call information, call notification, and disabling telephony.
Best practices #
It is recommended to send the integration activation request immediately after the user completes registration in your service. After that, you will get access to the branch API. Then you can fetch the necessary branch and user data via API and make further integration setup easier for the user on your side.
Also make sure to handle the case when an already registered/authorized user in your service comes from the Altegio Marketplace. Send the Marketplace integration activation request not only during registration, but also when the user logs in to your service or when the user comes from the Altegio Marketplace directly into your service’s personal account.
Please note #
Automatic user registration in your system #
To simplify connecting your integration, you can enable user data transfer during connection. In that case, when the integration is connected, you will receive user data (name, phone, email) and automatically register them in your system without making them fill in a form. According to our data, using this setting increases connection conversion by 30–40%. More details.
Connecting and setting up the integration in an iframe #
You can enable the setting Open the registration form in an iframe. Then when the user clicks Connect, your service’s registration page will open in the Settings tab of your app card in the Marketplace. This significantly increases user trust in your service, since interaction with your service happens inside the familiar Altegio interface. More details.
