Connect profiles
Lesson 8 of 25 5 min read
Let organisations connect an integration of the type, prove the credentials work, and take a type out of service safely.
A config-driven integration type is no use until an organisation can add an integration of it. The connect profile is what makes that possible. In this lesson you will add one and learn what its In service switch really does.
What a connect profile does
A connect profile lets an organisation connect an integration of the type. There is one for each integration type. Without one, organisations cannot add an integration of the type, unless the type has its own connect screen built in code.
Its body must make at least one call to the partner, to prove that the credentials the organisation entered actually work.
Add a connect profile
Open Administration → Maps & Profiles → Connect Profiles.
- Select Add. The New connect profile page opens.
- In Integration type, select the type, for example Acme API.
- Keep In service on.
- In Body, type the configuration. It must make at least one call, to prove that the credentials work.
- Select Validate. Correct the errors, if there are any.
- Select Save.
In service
| In service | Effect |
|---|---|
| On | Organisations can connect the type. |
| Off | Nobody can connect the type. Existing integrations continue to run. |
So In service controls new connections only. It is the right way to take a connect profile out of use, for example while a partner changes their sign-in, without disturbing customers who are already connected.
No versions to go back to
Like a client profile, a connect profile has no versions you can go back to. The Version column in the list only counts the saves. Keep a copy of the body before you change it.
Making the type appear for organisations
The connect profile is not the only thing an organisation needs. The routing guide adds one more step on the type's Details tab: set its Categories. Organisations see a type in the add integration dialog only when it is in a category. If a customer says "I can't find Acme API in the list", check the category and the connect profile.
Acme changes its sign-in
Acme announces that new accounts must use a different sign-in method from next week. Existing connections keep working until they migrate. You turn In service off on the Acme API connect profile, so nobody connects with the old method in the meantime. Customers already connected carry on. When the new body is ready and validated, you save it and turn In service back on.
Recap
- A connect profile lets organisations connect an integration of a type; there is one per type.
- Its body must make at least one call to prove the credentials work.
- In service off stops new connections; existing integrations keep running.
- There are no versions to go back to; the Version column only counts saves.
- A type also needs a category on its Details tab before organisations can see it.
Your progress is saved in this browser. Create a free account to keep it everywhere, take quizzes and earn certificates.