| Warning | ||
|---|---|---|
| ||
This section of our wiki is deprecated. You landed here because we developed new better tools to integrate with Maestrano and our Partners. We now have a brand new Developer Platform which simplifies a lot your integration on all our Partner Marketplaces (both to manage marketing listing and to manage your technical integration). If your application is already integrated with Maestrano, do not panic! Your integration still works perfectly. To simplify your journey with us and our partner's marketplaces, we will onboard you soon on the developer platform. If you want to know more, just send us an email (developers@maestrano.com), nothing to be afraid of |
When registering your application on maestrano.com, as an application provider, you will be given an access to a Maestrano App Provider Dashboard. The technical aspects of the integration can be found in your API portal (API tab in the menu). You will find here different tabs: Production, Sandbox1, Sandbox2, etc. The "Sandbox" tabs should be used during the integration phase, and to connect our production environment to all you different non-production environments. The "Production" tab should be used for the release of your application on maestrano.com, and should be connected to your production environment.
...
Table of Contents absoluteUrl true style none
...
1 - Where can I find the credentials I will have to use?
In your API portal, you will find the Production application credentials (to be used once the application goes live) and the Sandbox credentials (to be used during the integration phase, and for all non-production environment). Several Sandbox environments can be set up (with different credentials for every sandbox) if you need to manage several test environments; just ask our team if you need more sandboxes.
2 - How does the metadata endpoint work?
In order to understand your application and configure webhooks properly, Maestrano expects you to create a special "metadata" endpoint exposing the configuration of your application preferences in terms of Single Sign-On, data sharing subscriptions, webhooks etc.
...
Once setup, enter the URL of your metadata endpoint into your Maestrano App Provider dashboard then click on 'Update/Fetch'.
3 - What to include in my metadata endpoint?
The metadata endpoint should return a JSON document describing your configuration. Note that the call initiated by Maestrano to retrieve your metadata is authenticated via HTTP Basic authentication using your own API credentials (shared secret).
...
| Field | Type | Required for OpenID SSO | Required for SAML SSO | Change with the tenant and the environment | Defaults fields | Description |
|---|---|---|---|---|---|---|
| environment | string | - | - | Yes (with the env. only) | - | The environment of the platform your are integrated to; accepted values: |
| app.host | string | Yes | Yes | Yes (with the env. only) | - | Your application host To test your integration locally, see:Testing Webhooks locally |
api.id | string | Yes | Yes | Yes | - | The id of your app |
| api.host | string | Yes | Yes | Yes | if "environment" is set: value for Maestrano tenant | The platform host |
| sso.idm | string | - | - | - | same as config.app.host | Your Identity Domain Manager |
| sso.init_path | string | Yes | Yes | This value can be changed | - | Your application path that allows users to initiate the Single Sign-On handshake. Upon reaching this endpoint your application will automatically |
| sso.consume_path | string | - | Yes | This value can be changed on a per-tenant basis | - | Your application path to the SAML endpoint that allows users to finalize SSO authentication |
| sso.idp | string | Yes | Yes | Yes | if "environment" is set: | The platform host |
| sso.x509_fingerprint | string | - | Yes | Yes | if "environment" is set: | We will provide you the correct value for other tenants than Maestrano |
| sso.x509_certificate | string | - | Yes | Yes | if "environment" is set: | We will provide you the correct value for other tenants than Maestrano |
| connec.host | string | Yes | Yes | Yes | if "environment" is set: | The Connec! endpoint used to fetch data from |
| webhook.account.groups_path | string | Yes | Yes | This value can be changed on a per-tenant basis | - | Your application path where a notification will be posted |
| webhook.account.group_users_path | string | Yes | Yes | This value can be changed on a per-tenant basis | - | Your application path where a notification will be posted |
| webhook.connec.notifications_path | string | Yes | Yes | This value can be changed on a per-tenant basis | - | Your application path where notifications |
| webhook.connec.subscriptions | hash | Yes | Yes | No | false for all entities | The list of entities (organizations, people, invoices etc.) |
4 - How can I test my integration?
| Info | ||
|---|---|---|
| ||
After the release of our new website get.maestrano.com and before the release of our new developer platform, see the following article to test your integration: |
One of the sandboxes application should be used during the integration phase, or for any non-production environment. You can add the application to your dashboard easily by clicking on the Start Sandbox App button (API > Sandbox Tab > Start Sandbox App) and then choosing the appropriate company.
Once added to your dashboard, you can initiate the SSO process by starting the application, clicking on the application title.
...