iPaaS.com Integrator Onboarding
Goal: Successfully implement a new application integration on the iPaaS.com platform.
iPaaS.com integrations present in 4 categories: iPaaS.com Compatible, iPaaS.com Ready, iPaaS.com Certified, and One-Click. One-Click integrations are the most attractive to clients and most successful in the marketplace, but not all integrations will reach that stage. The following outlines the requirements and steps toward initial onboarding at the Compatible stage, and progressing the application through to One-Click if desired.
iPaaS.com Compatible (Will appear in Marketplace with “Compatible” Tag)
· Provides Hook, Queue or Event services
· Supports hosted in Multitenant Cloud, Private Cloud, or On-Premise
· Requires Application Versioning
· Dynamic: The API meets Open API Standard 2.0
· SDK: The API provides any accessible connector
Detail page is limited and describes what action is required to move to readiness.
Registration: Registration occurs in portal and includes the following information:
· Application Provider Profile including Name, URL, and Logo.
· At least one Product Name, Logo, and Version.
Expectations:
· The third party system has all necessary pieces to work with IPaaS.com.
· Detail page should identify data movement of 3rd party in relation to IPaaS.com as well as describe any supported scopes for webhook/event system.
· Integrator Registers here and has access to a sandbox environment for their integration.
Helpful LINKS:
iPaaS.com Ready (Will appear in Marketplace with “Ready” Tag)
The API has been registered with iPaaS.com and all the required information to integrate with it has been established. To become certified for the marketplace, objects and routes still need to be normalized to iPaaS.com
Detail page is limited and describes next action.
If an Integrator has associated themselves with the integration, then their profile will be shown in the integrators section.
Provisioning: All iPaaS.com users have access to Dynamic Integration Provisioning Tools within the portal.
All iPaaS.com qualified Integrators have access to the iPaaS.com Integrations SDK and permission to designate readiness.
Expectations:
· Establish that your integration is ready as the 3rd party and IPaaS.com has a connection.
Helpful LINKS:
iPaaS.com Certified (In Marketplace with “Certified” Icon + Subscribe Button)
The integration meets all standards and requirements of iPaaS.com for a customer or MiSP configure within the UI and does not require any access or knowledge of the developer tools to use it.
Detail page displays description, integration features, supported workflows documentation and the Integrator profile widget.
Certification: All iPaaS.com Registered Integrators have access to request certification of a Dynamic or SDK Integration.
Acceptance is required by Red Rook staff or Red Rook automation.
Expectations:
· Integration has no issue making a connection to the third party system.
· Integration has all Data Models made with operational methods completed.
· Integration has all supported/needed scopes handled.
· Integration has test methods made to ensure that all parts of the integration is operational.
· Integration has been demonstrated to be fully operational in all supported features as well as information/documentation.
Helpful LINKS:
One-Click Integration (In Marketplace with “Certified” + “One-Click” + Subscribe Button)
The integration has achieved marketplace certification and an approved party has saved workflow templates enabling the customer to have a plug-n-play experience.
Detail page displays description, integration features, supported workflows documentation and the Integrator profile widget. Access to view workflow templates.
Workflow Templates: All iPaaS.com Integrators and MiSPs may submit workflow templates to the marketplace making them available for all subscribers. Workflows are only available for a specific integration and version.
iPaaS.com Application Certification Process
Discovery Phase
Provide domain level expertise of 3rd party integrated product (One Time)
Market understanding / value proposition. Who is the target of the integration and value prop.
Establish legal relationships with the application provider and if not publicly available, obtain documentation / software.
Describe the business logic of integration and outcomes. From the user perspective, how will integration help? What will it automate, what problem will it solve, what process will it improve? Identify any gaps in the desired expectations which the integration does not automate.
EXPECTATIONS: init
Initial expectations set who is who and what roles are being filled such as integrator/developer, upline for 3rd party, upline for Red Rook..
NDA(s) signed and retrieved for respective parties. 3rd party system/software is accessible or gaining permissions.
Discussion points:
Why this integration? What will it accomplish for end users?
Identify gaps in the system that may come up with.
Decide which end-points of the 3rd party system will be needed to achieve the desired business outcomes. Group those end-points into Foreign Data Objects and associate each with an iPaaS.com MappingCollection.
For each supported MappingCollection, what data flow directions will be supported ( “To iPaaS” or “From iPaaS”)
For each supported MappingCollection, build methods (Get, POST, PUT, etc) to interact with the 3rd Party API
Decide which webhook scopes will be supported by the 3rd party Application Services.
EXPECTATIONS: Development
Discover all data collections to be supported and how it relates to IPaaS.com in the integration.
Decide upon supported operational methods.
Based on data collections group supported scopes.
Register for sandbox and attain SDK.
Setup SDK and make connection with 3rd party.
Develop all data models .
Setup event system with scopes and webhooks
Inside your iPaaS.com sandbox, create template mappings for each supported MappingCollection. This effort is performed in the sandbox and establishes how data will be mapped between the 3rd Party API and the iPaaS Common Data Model. Define each relationship from: Field to field Mappings, Dynamic Formulas, Static values, and Translation Mappings.
As the domain expertise, it is important that any guidance or special considerations for data integrity while moving data to/from the 3rd Party Application be noted. Also, any best practices for template mappings should be noted in the MappingCollections and Fields for subscribers to view.
EXPECTATIONS: Testing
Develop tests for your integration and document the flow of each test.
In the sandbox environment for data needed create the template mappings for the data supported and describe best conventions needed. such as a needed field coming from the 3rd party that needs to be mapped specifically.
With testing created and documented now to present the operation of the integration to be as discussed and its success on both parties based on operation method and data.
Registration and Profiles
Create Application Provider Profile (Brand, Company URL)
Create Application Profile (Name, Product URL landing page and all currently supported versions)
Example:
Developer / Application / Version
Adobe / Magento / Open Source 2.3.x
Adobe / Magento / Open Source 2.4.x
Adobe / Magento / Open Source 2.5.x
Developer / Application / Version
BigCommerce / BigCommerce / Customer API v2
BigCommerce / BigCommerce / Customer API v3
BigCommerce / BigCommerce / Transactions API v2
Set your own price: $x up front + $y p/month.
Technology partners and MiSPs may promote your integration to their existing customers or may wish to target new customers featuring the value of iPaaS.com and your integration. In many cases, unique value opportunities emerge when two or more applications are integrated together. If you wish to share information on the typical market, ideal buyer profile, 3rd party product positioning or any information that may empower the marketplace to promote your integration, we will share this privately with those parties.
Integration Maintenance (Ongoing)
Continual improvement, respond to wish-list with new features and address stability of integration where needed.
Add/Verify support for new versions of the integrated application
As a best practice, we recommend providing the ability to respond to workflow questions and 3rd party API exception handling issues. *
* As the Integrator program and the iPaaScom platform matures, certification of Integrations will improve to where this requirement is not necessary.
Integration Scoring Overview
With the interest of keeping integrations relevant to the ecosystem, iPaaS.com will mature to score, rank and provide transparency through the marketplace based on merit. Scores that fall too low will be removed from external search requests and may be removed from the marketplace entirely.
Version Relevance
Lists of Application Providers, Applications and Version release dates are maintained and populated through purchased industry lists, public company registration, trade publications, press releases, or verified submissions from anyone in the iPaaS.com ecosystem. Certified Integrations are associated with an application profile and all versions of that application supported by the integration are related. Any Integration that does not support the latest version or release of an application will receive a scoring deduction.
Value to Customer
Paying subscribers will be solicited to provide a review. Negative reviews will demonstrate a sign of customer dissatisfaction in value. A negative review may be addressed with the customer in hopes the customer will change their review voluntarily, or a negative review may be disputed which with proper reasoning may exclude consideration of the negative review. Negative reviews that are not addressed, go undisputed, or the dispute was not accepted will result in a scoring deduction.
Subscriber cancellations will be treated as an expression of customer dissatisfaction through action rather than review. We understand that in some cases a customer may cancel for reasons that do not represent a limit in the ability of the integration. Because of that, we will only apply scoring reductions when excessive cancellations occur in a measured period of time (Assess to use quantity or percent depending upon total subscribers)
Misrepresentation of Integration
Subscriber cancellations that occur after 1 month and within the first 7 months of subscribing will be treated as representing by the customer that their expectations were not met and irreconcilable, thus had to find an alternative integration solution.
Customer Realigned
We know that customers aren’t always right. Sometimes they have to try a harder way before they recognize your work for its greatness. Any customer that re-subscribes at any future time will automatically remove scoring deductions from prior negative reviews and any previous cancellation deductions that were considered. If any negative reviews were previously submitted, they will display with a highlighted TAG that this customer returned to the product after evaluating alternatives. The subscriber will also be asked to comment on their previous review should they have a new opinion upon re-subscribing.