API Query
  • 28 Feb 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light

API Query

  • Dark
    Light

Article summary

DataBee empowers you by offering diverse input source types, enabling effortless data ingestion. API Ingest opens doors to access real-time, structured, and semi-structured data from a multitude of external data sources. To begin utilizing API Ingest in DataBee, it's imperative to first register DataBee with the external data source API to gain access to the stored resources. Registration requirements vary depending on the specific API being utilized. Once registered, the data source generates credentials, which are crucial for onboarding the data source within DataBee.

To configure API Ingest for your preferred data source, follow these steps within the DataBee user interface:

Click on the Data button and select +Add New Data Source in DataBee UI. Choose your preferred data source from the list of available options. You will now be directed to choose your storage account. To fetch data via API Ingest, click on API Ingest.

configure_data_feed

You will now be redirected to the "Configure data source" page. Follow the flowchart displayed on the right, for a visual guide, outlining the step-by-step configuration process.

Step 1: Configure Data Source

Enter the data source details in the fields provided.

  • Data Source Name: a user-friendly name for the data source

  • Owner Name: the name of the point of contact for the data source

  • Owner E-mail: email address of the owner

Once you have entered the required information, click Next to proceed to the next step.

API_ingest_1

Step 2: Configure Connection

Fill in the configuration details in the fields provided, to connect to your API endpoints.

  • API URL(s): the target URL endpoint(s) for the API

  • Authorization Method: Select either OAuth2 or Basic as the authorization method

If you choose OAuth2, enter the following details.

  • Client Key: the client key used for OAuth2 authorization

  • Client Secret: the client secret used for OAuth2 authorization

  • Token URL: the URL to retrieve the access token authorization

API_ingest_2_OAuth

If you opt for Basic authorization, provide the necessary details.

  • Username: the username to be used for Basic auth

  • Password: the password to be used for Basic auth

Click Submit to finalize and complete the configuration process.

API_Ingest_2_Basic



Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence