Integration stages

This article will show you what kind of process we have for our partners from initial request to going fully live with the integration.

Check out our most up to date API documentation to understand the possibilities and limitations.

The first step of this partnership is to get in touch with our Team so we can discuss and better understand your needs.

After having understood the opportunity of a mutually beneficial partnership, we will share our Commercial Agreement for your signature. This agreement has been standardized in all partners and describes the basic requirements / expectations of our API partners. To protect both parties, some partnership opportunities may also require the signing of a mutual confidentiality agreement.

Once the agreements have been signed, we will add the integration to our partners’ portfolio. We only incorporate new partners when we are sure that we have enough development resources to support the project. We can have a queue of development with expected timelines for each new enquiry

We will use api@chekin.io exclusively for requests and API access.

We will analyze the technical feasibility of integration and we will discuss different implementation options with your development team / technical leader. In this step we may request for changes or new endpoints in your APIs, and you may request the same to us. At the end we will agree on an integration flow that works for both of us.

At this stage we will need:

  • A technical contact
  • A test account
  • Access to your API Documentation

If you are integrateing to our API we will provide the same to you.

This step is very important to scope the overall integration flow and detect all the blockers or extra development that must be done prior launching the integration.

After we all agree on the integration flow, the integration will start:

1- We build to your API

  • You will provide us a partner & test account.
  • API credentials
  • Developer support 

2- You build to our API

  • We will provide you a partner & test account.
  • API credentials
  • Developer support via email and a dedicated Slack channel
            o Support is provided through email. Response time is 1-2 business days
    o Phone and live chat are currently not offered for dev support

We’ll keep you up to date with the changes on our API.

This process is typically about two-weeks, but can vary depending on whether any additional fixes are needed.

Pilot testing outcomes

  • If no issues are encountered, then we closed beta pilot and the solution will be available for all users as an open beta.
  • If mild issues encountered, they can be fixed without returning to test account. Example: Unexpected formatting, excessively high polling intervals.
  • If severe issues encountered, integration need to be fix and returned to the test environment. Once the issues are fixed, a new call can be scheduled to re-certify the integration.

A brief period (typically 2-4 weeks) to check for any remaining issues and collect feedback from users about any UI or integration improvements. Any number of accounts may be connected.

Beta testing outcomes

  • If a significant integration-breaking bug is found, integration might be returned to pilot-testing or pending certification.
  • If no issues occurred we’ll remove “beta” flags and labels from the integration

Maintenance

In case you’d like to develop new integration features or do any kind of maintenance work, let us know and we’ll help you scope that new project, you may need to discuss with our Partnership team if the solution you are developing is not part of the commercial agreement. Any major change will require a certification call.

Support expectations and process

In case of issues for which you need developer support from Chekin please send your request to api@chekin.io and we will respond as soon as possible. Provide us with as many details as possible (e.g. methods, results, error messages) this will speed up our investigation.

Please Login To Download Attachments
Related Articles