A lot of this is covered in our integrator training, but this document is explicitly about the items you will want to have in place before publishing your integration. If you were building this integration with the intent to list it publicly in the iPaaS.com Marketplace, you may have already completed a lot of this — but if you built an integration for a client and later decided to list it, this document has a lot of information you should be aware of.
Note that these are all modeled after how iPaaS.com documents and markets the integrations built by our internal team. We regard these as best practices, but they are not required.
Please see our Move integration data reference to know whether you should add these details in staging and have us redeploy, or add them directly to the integration in prod.
Within the Integrator UI
Integration Settings
There are various pieces of information on the integration detail page that you will want to make sure are filled out in the integration settings.
Note: These settings are available in your iPaaS.com account. They can be found in the VIEW AS INTEGRATOR section of your account.
Image: Upload an image that should be the software's logo on a white background, 150x150 px.
Marketing Info - Title: The publicly facing title for the integration.
Note: Do NOT edit the integration name itself or you risk breaking the integration.Marketing Info - Description: A few sentences and/or a bulleted description to be used on the integration detail page.
Categories: Select the categories that are most relevant to the piece of software you integrate with. If there is not an applicable category, please reach out to integrations@ipaas.com to discuss adding a new one.
Using the "hidden" category will remove it from the marketplace, so ensure this is not set.
Price: Enter the integration's monthly subscription price in the Price Monthly field.
Note: Your integration detail page can be previewed at https://{environmentName}.ipaas.com/{companyId}/customer/subscription-mgmt/app-marketplace/company-detail/{integrationId}. {companyId} and {integrationId} are auto-populated when you open the integration detail page in the UI, so the simplest path is to copy the URL from there and swap in your {environmentName}.
Supported Features
When you built out your integration, you probably created these as bare-bones items, but filling out all of the details allows users to see the data types and endpoints your integration interacts with.
[IMAGE PLACEHOLDER: Supported Features screenshot — add via editor]
Template Mapping Collections
If you wrote the integration for a specific client, you may have either forgone template mapping collections or tailored them for a single specific use case. Before listing the integration, we recommend you:
Only include general custom fields in your mappings. Do not include client-specific ones.
Ensure any IDs that are needed are clearly marked as placeholders and any client-specific IDs are removed.
Mapping Collection Descriptions
This field allows you to inform your users about the mapping collection and what is needed to get it set up and working. It also allows you to call out any required fields or special functionality.
Mapping Descriptions
Each mapping can have a description field filled out. We recommend this for any dynamic formula or any other mapping that needs to be described to the user.
External Documentation
You can see examples of integration documentation here, but at a high level, these are outlined in the following way:
Installation Instructions: Outline the steps that the MiSP or user needs to take to set up the integration. Should include steps in both the external system and iPaaS.com.
Known Limitations: Discuss any limitations from the external API or flows that have not been built.
Connections and Settings: Outlines the presets, persistent data and other fields on the connections and settings page.
Error Messages: A list of common error messages coming from the integration or the external system and how a user can resolve them.
API Endpoints: A list of endpoints the integration interacts with.
Mapping Collections: A collection of documentation with one page devoted to each mapping collection (or group of them). Most of this information is pulled from the mapping collection and mapping descriptions.
NOTE: The examples above are iPaaS.com's own integration docs, which we host and maintain. For partner-built integrations, iPaaS.com does not host your instructions, but we are happy to create a page at support.ipaas.com that links out to your documentation.