Technical documentation describing how to link and authenticate a 3rd party application with an Ebriza application
Background
When you are registering your application inside the Ebriza platform you will be asked to provide installation steps that will help and guide the user through the installation flow.
In the case that one of the installation steps requires an authentication in your system,
we provide you two methods of doing this.
Method 1 - External authentication
If you have opted for this type of authentication, at some point during the internal application installation flow the user will be prompted with a screen that looks like this:
Where the gray bar represents the installation step title, the white bar represents a short description, and the login button will be replaced with your application name.
When the user clicks the button, we will open a new tab with the URL that you have provided for us and we will append to that URL the necessary information so that you can confirm back to us if the authentication was successful.
Information that we send:
- ClientId - Identifies the current user and the current installation instance
- Callback - The endpoint that you will have to call when the authentication succeeded. Encoded with JavaScript's encodeURIComponent
Important: You will need to save the ClientId in your own system because this unique identifier will represent from now on the Ebriza user. You will need this when you will make API calls towards Ebriza.
If the authentication was successful you will need to make an API call towards the callback the we provided previously.
Information that we need back:
- ClientId - The previously sent unique identifier. We need this information in order to properly identify the user and the installation instance
If everything was successful we will notify the user and we will proceed with the internal application installation flow.
Examples
The URL that you have provided for us during the application registration:
http://yourapp.com/login
The URL that we will open in a new tab:
http://yourapp.com/login?clientId=5c931384-b9ff-4a8d-ba02-4e54ab09f1fb&callback=https%3A%2F%2Febriza.com%2Fmarketplaceapps%2Fconfirmauthentication
The API call that you will make when the authentication succeeds:
curl --request POST \
--url https://ebriza.com/marketplaceapps/confirmauthentication \
--header 'Cache-Control: no-cache' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data clientid=5c931384-b9ff-4a8d-ba02-4e54ab09f1fb
Pro tip: Do not save the callback URL. We don't guarantee that it won't change in the future. However we grantee that the ClientId and Callback parameter names won't change.