Shieldox - integration checklist
- Alex Barret (Unlicensed)
Single Sign-On
Only applicable to applications supporting Single Sign-On
Pay attention to Users / App instances and Companies
Each company is identified by a channel_id and a name
Each app instance is identified by a group_id and a name
Each user is identified by a user_id, a first name and a last name
A user can have multiple company and app instances on each companies, an company can have multiple users
Pay attention to your existing users
Do not create a new account for your existing users wanting to use Maestrano
Pay attention to your users deleting their Maestrano account
To know more: How does the SSO Process work
How to test your integration
To test the SSO, create 2 accounts on Maestrano with 2 different email addresses (user1, user2) :
- On the first account, create 2 different companies (company1, company2) and add Shieldox to both of them (group_id1, group_id2)
- Invite the second user account (user2) to one of them (company1)
REQUIRED Scenarios to test
Check the box if the scenario will be developed
REQUIRED Comments from the integration
Check the box if the test is OK + add comments
Comments from the testing
Check the box if the test is OK
- When a user launches Shieldox for the first time on his company, it creates a new user account in Shieldox, using the user and company details
- OK
- OK
- When a user launches Shieldox a second time from Maestrano (same user, same company, same app instance), it redirects to the existing account already created
- OK
- OK
- When a user launches Shieldox from a second company on Maestrano (same user, second company), it creates a new user account in a new company in Shieldox
- OK
- OK
- When a new user launches Shieldox for the first time from an existing company (user2 invited to company1), it creates a new user in an existing company in Shieldox
- OK
- OK
- When an existing user of Shieldox creates an account on maestrano.com and launches Shieldox on the platform, Shieldox proposes to the user to be redirected to its accounts
- OK
- OK
- When a user deletes Shieldox on Maestrano, Shieldox stops sending bills/invoices and stops fetching/sending data for this account to Maestrano
- OK
- OK
Single Billing
Only applicable to applications supporting Single Billing
Pay attention to Recurring Bills / Bills / Child bills
To know more: How does the Single Billing process work
Pay attention to your existing users
Do not charge via Maestrano your existing users coming from your app to Maestrano
Pay attention to your users deleting their Maestrano account
How to test your integration
For now you cannot test your Single Billing integration on your own.
For your tests account, you can still ask us using our Developers Help Desk to confirm we have received your bill and its amount
REQUIRED Scenarios to test
Check the box if the scenario will be developed
REQUIRED Comments from the integration
Check the box if the test is OK + add comments
Comments from the testing
Check the box if the test is OK
- In case Shieldox has a free trial, when a new user subscribe to Shieldox, no bill is pushed to Maestrano before the end of the trial period
- OK
- OK
When a user subscribes to Shieldox with a billing plan,
- a recurring bill is sent to Maestrano for this organisation and the user will be invoiced every month
- a new bill is sent to Maestrano for this organisation every time the user should be invoiced
- OK
- OK
When a user changes its billing plan on Shieldox,
- the old recurrent bill is deleted from Maestrano and a new recurring bill is created
- bills amounts are updated the month after
- OK
- OK
When the last (or unique) user of a company deletes Shieldox on Maestrano,
- the recurrent bill is deleted from Maestrano
- no new bill is sent to Maestrano
- OK
- OK
Connector launch
Only applicable if the integration uses the connector framework
REQUIRED Scenarios to test
REQUIRED Comments from the integration
Check the box if the test is OK + add comments
Comments from the testing
Check the box if the test is OK
When I launch a new connector on my dashboard, I am redirected to the connector page
- OK
- OK
When I enter the correct credentials in the connector to connect to Shieldox, I am redirected to Shieldox to finish the integration and then redirected to the connector page
- OK
- OK
When I enter incorrect credentials in the connector to connect to Shieldox, a message is displayed on the connector page telling me my credentials are incorrect
- OK
- OK
When I launch a connector already linked to my Shieldox account on my dashboard, I am redirected to the app directly, not to the connector page
- OK
- OK
Data sharing
API Analysis considerations / API Limitations
Only applicable if the integration uses the app's public API
- Does the API support oAuth or API keys ? Do we need to request these credentials to the application provider ? (developer portal, contact support, ...)
- Is there an expiration date on the API access (oauth token expiration for example)
- Can we filter data fetched from the API based on the last modification timestamp ?
- Which entities are read-only ?
- What are the unique constraints on entities so we can apply merging rules ?
REQUIRED Scenarios to test
Check the box if the scenario will be developed
REQUIRED Comments from the integration
Check the box if the test is OK + add comments
Comments from the testing
Check the box if the test is OK
- OK
- OK
For Apps sharing transactional/payment data:
When you sell a product/service in a different currency from Shieldox it either translates or converts accordingly into all other apps and the Impac! Dashboard
- OK
- OK
When I click on "Synchronise historical data" my historical data from Shieldox are imported in Connec! and I can see them in other apps
- OK
- OK
Precisions regarding data mapping
In this section are listed advices to map non-trivial mapping