Skip to main content

ConnectorDetails Embeddable Guide

The ConnectorDetails embeddable allows you to view the details of connectors. Like all Ingestro pipeline components, the ConnectorDetails embeddable is easy to integrate into your existing application.

This guide will help you implement the ConnectorDetails component and show how to configure it based on your specific requirements:

  1. Install the Ingestro package
  2. Get your Ingestro license key
  3. Get the access token
  4. Implement the embeddable component in your application
  5. Configure the component based on your specific use case

Let's get started​

Step 1: Install the Ingestro package​

Installing the Ingestro package is super easy.

Install with NPM:

React
Angular
Vue
VanillaJS
npm install @ingestro/pipelines-react

Install with Yarn:

React
Angular
Vue
VanillaJS
yarn add @ingestro/pipelines-react

Install via CDN:

VanillaJS
https://unpkg.com/@ingestro/pipelines-vanilla-js

Step 2: Get your Ingestro license key​

You can get your Ingestro license key from the Ingestro User Platform.

If you don't have an account yet, you can sign up here.

info

Please note that pipelines in development mode only send the first 100 rows to your defined output destination. If you would like to increase your quota, please contact us at [email protected].

Step 3: Get the access token​

In order to authorise yourself or rather the component you have to first get the access token via our authentication API.

You can get access tokens for two different cases:

  1. You want your internal users to view a list of all pipelines
  2. You want your customers to view a list of all pipelines

You want your internal users to view connector details

  1. To get the access token for an internal user, you need to first create an user in the Ingestro User Platform or use the user API
  2. Use the user's email address and your license key to request the access token. Here is the cURL or JavaScript request you can use to get the access token:
cURL
Javascript
curl -X 'POST' 'https://api-gateway.ingestro.com/dp/api/v1/access/token' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "license_key": "LICENSE_KEY",
  "auth": {
    "identifier": "E-MAIL",
    "type": "USER"
  }
}'

You want your customers to view connector details

  1. To get the access token for your customer, you need to first create a sub-organization (sub-org) via the sub-organization API
  2. Use the sub-orgs's identifier and your license key to retrieve the access token. Here is the cURL or JavaScript request you can use to retrieve the access token:
cURL
Javascript
curl -X 'POST' 'https://api-gateway.ingestro.com/dp/api/v1/access/token' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "license_key": "LICENSE_KEY",
  "auth": {
    "identifier": "SUB_ORG_IDENTIFIER",
    "type": "SUB_ORG"
  }
}'  # Replace LICENSE_KEY with your license key & SUB_ORG_IDENTIFIER with a sub-org identifier

Step 4: Implement the embeddable component in your application​

With the package installed, you can add the ConnectorDetails component to your application.

First, import the component in the file where you want to use the ConnectorDetails component:

React
Angular
Vue
VanillaJS
import { ConnectorDetails } from "@ingestro/pipelines-react";
import "@ingestro/pipelines-react/index.css";

Step 5: Configure the component based on your specific use case​

Add the code snippet below and insert the component on the page where you want it to appear:

React
Angular
Vue
VanillaJS
<ConnectorDetails
  accessToken="ACCESS_TOKEN"
  connectorId="CONNECTOR_ID"
  settings={{
    i18nOverrides: {},
    language: "en",
    modal: true,
  }}
  onConnectorUpdate={({ data }) => {
    // runs after the configuration of the connector was changed
    // data: connector object after update
  }}
  onConnectorDelete={({ data }) => {
    // runs when the connector is deleted via "Delete" button
    // data: deleted connector object
  }}
  onClose={() => {
    // runs when the creation workflow is closed via the "Cancel" button of the Setup page or the X button of all steps is used
  }}
/>

accessToken

Add here your access token

connectorId

Add here the ID of the connector you want to display

settings

i18nOverrides

Allows you to override each text element in the interface

language

Defines the language of the embeddable (so far we only support English ("en"))

modal

Defines whether the component is shown inline (false) or within a modal view (true)

onConnectorUpdate

Runs after the user saved changes they made to the connector

onConnectorDelete

Runs after the user has deleted the connector

onClose

Runs when the user trys to exit the "Connector Details" by closing the modal using the "X" button or clicking outside the modal