Kinduct's API Integration feature provides you with an interface to setup API connections to various vendor partners - allowing you import data into your Kinduct site via API.
The following integrations are currently supported:
- Diamond Kinetics
- Zebra Game
- Zebra Practice
We will be adding more as we continue to work with vendors.
Our API integration feature is permission based. Once enabled, users with the appropriate permission will see API Integrations under the Data Management menu item:
Clicking on API Integrations will take you to the Integrations page:
This is the main page and presents you with several options. The main area of the page is devoted to your list of configured integrations. This table shows the name of the integration, the integration vendor, a link to the logs that have been generated (indicating the number of logs), and dates showing when the integration was initially created and its most recent update. Search capability and custom table pagination are also included on this main page.
Each entry in the table has an associated context menu that provides actions specific to that integration entry:
Details about the options available are provided below. Here's how to create a new Integration entry.
Creating a New Integration Entry
At the top of the Integration page you'll see the Create Integration button:
Clicking the Create Integration button opens a page to enter the details for a new Integration. The page provides a drop-down list of all the vendor integrations currently supported by Kinduct. Selecting an integration from the list will dynamically populate the page with the necessary credential fields for that specific integration. In the example below an Integration with Push is set up:
Once selected you must enter a name for the Integration, as well as entering credentials in the other fields associated with the integration account. Once all of the fields are entered you can verify that everything works by clicking on the Validate Credentials button at the bottom of the form.
If the credentials work as expected then you will be able to save your Integration settings by clicking the green Submit button. Doing so will save your settings to the database and return you to the main Integrations page, where you'll see your new Integration at the top of the table:
Each Integration entry has its own context menu containing specific actions that can be performed on that Integration. Each menu option is detailed below.
Clicking this link will take you back to the Integration credentials page where you created your new Integration entry. This can be very handy if you notice that your Integration isn't pulling data, or if you know you've changed your credential information. This action allows you to enter your new details, validate the credentials, and then save your new settings to the database.
This is where the data actually gets pulled from the vendor site into your Kinduct platform:
As you can see from the image above, there are two options when manually pulling data from the vendor. You can make use of the default button which pulls data for the previous 24 hours, or you can select a custom date range using the date picker.
NOTE: The date picker allows a maximum of 28 days when determining a range.
Once you're happy with the date range, click the Import Data button to begin the data pull. You'll be redirected to the log page for your Integration and see spinning cogs next to the date. This indicates that the Integration is busy pulling the data and processing it in the Kinduct platform.
The other columns indicate, from left to right, the date range for which the data was retrieved, the method ("Manual" or "Scheduled") with which the data was pulled, how many new records were pulled with that particular entry, the number of missing users (explained below) associated with that entry and, lastly, the actions associated with this entry, of which there is currently only 'delete'.
Clicking on the trash icon will launch a modal asking if you're sure you want to delete the log entry and all the data associated with it:
One of the columns associated with each log entry is 'Missing Users', which is a persistent tally of any users for which you've pulled data but don't yet have a match within the Kinduct platform. Any user identified in this way has data available on the vendor site but is not yet reportable within Kinduct. You can remedy this by assigning or creating a user for each entry in the Missing User list. Click on the Missing Users button at the top of the logs page:
This will redirect you to a new page showing you the complete list of users that have been found having data on the vendor site but that have no match in Kinduct:
In the example there is data in our Push account for a user named "Test Account" but we do not have a match in Kinduct. We can create a match by clicking on the pencil icon in the 'Actions' column for that user. Doing so will expand the section below the user:
You have two options here: you can either Create User or you can Match User to an already existing user. Choosing to create a user will take you to the new member page in your Kinduct platform, after which any data associated with "Test Account" will match to your new user account. Choosing to match user allows you to choose from a drop-down list of existing users in your platform and match to one of those users. Any subsequent data pulls for the currently missing user will now be associated with the user to which you matched.
Clicking this option will take you to the Logs page for your selected integration, which is shown in the 'Pull Now' section.
Clicking this link is a quick way to make sure that your currently saved Integration credentials are still valid. Once clicked, a test connection is made to the vendor with the current credentials - if successful it will show a green notification bar at the top of the page; if unsuccessful, it will alert you with a red warning, after which you can click to edit the credentials using the context menu option Edit Credentials.
Clicking this option will delete your Integration. You'll be presented with a dialog box asking if you're sure you want to proceed: