Developer Resources

Integration Approval Process

The integration approval process requires that partners validate their integration product with the iCIMS ISV Enablement Team before it can be listed on the iCIMS Marketplace as Standard or Prime. There is an initial validation process that must be completed the first time a new integration is built. There is also a revalidation process for circumstances where there have been changes to the integration or a product is found not to be following the standard.  

Initial Validation

The iniital validation process consists of a video submission where the vendor drives an end-to-end demonstration of the integration. The iCIMS team will monitor logs, ensure that the correct fields are being read and written to and that information is communicated in real-time. The integration is expected to follow the standard integration as documented.  When the partner confirms they are ready for their integration to be validated for approval, the iCIMS ISV Enablment Team will send the validation requirements that are specific to the integration category which will include:

Testing Use Cases

Use Case 1:  End to end without Errors (video used as collateral by both iCIMS and partner)

This video should showcase the working integration and can also be used for:

  1. Customer Integration Demo
  2. Marketplace Marketing

Use Case 2:  Duplicate Request Error Handling

  1. Does not require a video, just screenshot(s) of the error
  2. Should produce a 400 error response with a user-friendly message in the payload for customer display

Use Case 3:  Missing Required Field Error Handling

  1. Does not require a video, just screenshot(s) of the error
  2. Should produce a 400 error response with a user-friendly message in the payload, with the missing required information, for customer display

After the approval process, iCIMS requires the vendor to provide and confirm the following:

  • Fields that are read and written to through the API. Fields should be listed out by profile type and access type: Read Only, Read/Write
  • Information required by the partner to enable the integration on a client’s iCIMS Platform
    • For example:
      • IP addresses to allowlist
      • Package IDs
      • Other IDs
      • Credentials
      • Customer ID
    • Note that values that will differ across client platforms shouldn’t be hardcoded
Revalidation Process

For a partner to receive a designation as Prime or Standard in the iCIMS Marketplace they must first validate the connector with the iCIMS ISV Enablement Team. This designation improves the partner’s position in the Marketplace. There are specific circumstances that will require a connector is revalidated to maintain the designation.

Prime Connectors

The connector revalidation process applies to any Prime connector listed in the marketplace that has been validated prior to new Prime features being made available. The revalidation process will also apply to Prime connectors that have been validated and during implementation it is reported that the partner is not adhering to the process or features that were validated.

Standard Connectors

The connector revalidation process will also apply to any connectors that are listed in the iCIMS Marketplace as “standard” and during implementation it is reported that the partner is not adhering to the process or features that were validated.

For both Prime and Standard integrations the required workflows and functionality are documented in the iCIMS Developer’s Guide. When a connector is initially validated the partners are provided with the specific requirements for their connector type. When revalidation is required the partners will follow the most recent version of the iCIMS developer’s guide and they will be provided with the requirements to revalidate their specific connector type.

When a new feature is introduced that requires revalidation Partners will be notified via email when the feature is released and if the new feature is mandatory. This will also be documented on the developer’s site. For new features that are mandatory partners will have 1 year from the time of release to complete the revalidation.

Process

  1. When it is determined by the iCIMS ISV Enablement Team that a connector requires revalidation the Partner will be notified via email. The iCIMS Partner Manager and the Marketplace Administrator will be included in the communication
    1. The partner may also email the iCIMS ISV Enablement Team to initiate the revalidation
  2. The email notification will indicate the section in the iCIMS Developer’s Guide that documents the specific connector and they will be provided the connector revalidation requirements
  3. The revalidation must be completed within 90 days of confirmation with the partner resources
    1. If the partner does not respond the Partner Manager will reach out to confirm receipt of the notification
  4. The partner will be provided sandbox access to complete the revalidation
  5. The iCIMS ISV Enablement Team will provide sandbox support
  6. If the partner does not complete the validation by the due date the Prime or Standard designation in iCIMS designation in the iCIMS Marketplace will be removed.