---
title: API
description: Learn how to connect and configure API connections in Infoveave to communicate data between different software systems or applications.
---

import { Steps } from '@astrojs/starlight/components';
import { MediaPlayerComponent } from "../../../../../components/video-player";
import RunScript from "../../../../../components/RunScript.astro";

# API

<MediaPlayerComponent
  video="NewApiConnections.mp4"
    chapters={
[
  {
    "start": 0,
    "end": 6,
    "text": "Click Connections under Administration",
    "description": "From the Infoveave menu, click on 'Administration', then select 'Connections' from the dropdown menu to manage your data connections."
  },
  {
    "start": 6,
    "end": 8,
    "text": "Add New Connection",
    "description": "On the 'Connections' page, click the 'New Connections' button located at the top right to begin the process of adding a new connection."
  },
  {
    "start": 8,
    "end": 11,
    "text": "Select API Connection",
    "description": "Click the 'API' option under the 'Cloud services' section to create a new API connection."
  },
  {
    "start": 11,
    "end": 20,
    "text": "Configure API Connection",
    "description": "Enter the name for your new API connection. Set the 'API request type' and input the authentication URL. Fill in the 'Client ID' and the 'Client secret' with the appropriate password."
  },
  {
    "start": 20,
    "end": 22,
    "text": "Validate API Connection",
    "description": "Click the 'Validate' button to check if the entered API connection details are correct and establish a successful connection."
  },
  {
    "start": 22,
    "end": 25,
    "text": "Save API Connection",
    "description": "After successful validation, click the 'Save' button to finalize and add your new API connection to Infoveave."
  }
]


    }
  poster="/images/introduction-poster.png"
  posterText="Creating an API Connection"
  client:load
/>

API connection helps communicate data between different software systems or applications through standardized interfaces and authentication protocols.

## Adding an API Connection

To create a new API connection:

<Steps>
1. Go to **Administration** > **Connections**
2. Click **New Connection** and select **API** from the available connectors
3. In the **New API Connection** form, provide the required configuration details
</Steps>

## Connection Parameters

When setting up an API connection, you need to provide the following details:

| Field | Description |
|-------|-------------|
| **Name** | A unique name to identify your API connection |
| **Auth Request Type** | The authentication method type |
| **Auth URL** | The authentication endpoint URL for the API |
| **Client ID** | Your application's client identifier for API authentication |
| **Client Secret** | Your application's secret key for API authentication |

## Authentication Configuration

Configure how Infoveave should authenticate with your API:

- **Add Auth Headers**: Include authentication tokens in request headers
- **Add Auth Form Data**: Send authentication credentials as form data

## Supported API Types

Infoveave supports connections to various API types including:

- **Cloud Services**: Google Sheets, HubSpot, Jira
- **Custom APIs**: GraphQL endpoints and REST APIs
- **Enterprise Systems**: Various business application APIs

## Steps to Validate and Save

<Steps>
1. After configuring your API connection parameters, click **Validate** to verify the connection
2. If validation succeeds, click **Save** to store the connection
3. You can now use this API connection as a datasource in your Infoveave workflows and visualizations
</Steps>

## Example Use Cases

With an API connection configured, you can:

- Sync data between different business applications in real-time
- Automate data extraction from cloud services like Google Sheets
- Integrate with project management tools like Jira for reporting
- Connect to CRM systems like HubSpot for customer analytics
- Query GraphQL endpoints for flexible data retrieval
- Build dashboards that combine data from multiple API sources
- Create automated workflows that trigger based on API data changes
- Establish bidirectional data sync between Infoveave and external systems