API
Creating an API Connection
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:
- Go to Administration > Connections
- Click New Connection and select API from the available connectors
- In the New API Connection form, provide the required configuration details
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
- After configuring your API connection parameters, click Validate to verify the connection
- If validation succeeds, click Save to store the connection
- You can now use this API connection as a datasource in your Infoveave workflows and visualizations
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