- 22 Feb 2025
- 1 Minute to read
- Print
- DarkLight
API Ingest
- Updated on 22 Feb 2025
- 1 Minute to read
- Print
- DarkLight
DataBee supports a wide range of data feeds and enables effortless data ingestion. API ingestion opens doors to access real-time, structured, and semi-structured data using API’s. The first step is to register DataBee with the external platform. This can be as simple as creating a service user with basic credentials or setting up an API client with policies and permissions on the target platform. Refer to the instructions on the specific data feed you are trying to ingest.
This article walks through the general steps when using API ingestion.
Start by clicking on the Data button and select Data Feeds
Next, click on the +Add New Data Feed button
Choose your preferred data feed from the list of available options. You will now be directed to choose your ingestion method. To fetch data via API’s, click on API Ingest.
You will now be redirected to the "Configure Data Feed" page. Follow the flowchart displayed on the right, for a visual guide, outlining the step-by-step configuration process.
Step 1: Configure Data Feed
Enter the data feed details in the fields provided.
Data Feed Name: a user-friendly name for the data feed
Owner Name: the name of the point of contact for the data feed
Owner E-mail: email address of the owner
Once you have entered the required information, click Next.
Step 2: Configure Connection
Fill in the configuration details in the fields provided, to connect to your API endpoints.
This dialog box may look different depending on the data feed. In the example below, we are configuring Azure AD. This data feed uses OAuth2 as the authorization method. This will be determined automatically by the feed.
A summary of the fields is described below
API Base URL: This is the base API endpoint that DataBee will call
Event Types: The data feed can provide one or more types of data or events. This field will be prefilled will ALL the events supported.
Authorization Method: Prefilled
Client Key / Client Secret: Credentials
Token URL: The URL to retrieve the access token authorization
Each datasource will have specfic instructions on filling in these fields including any <placeholders> in the URLs
Once complete, click Submit to finalize and complete the configuration process.