Documentation

Authentication

The authentication methods Ingestics supports for connecting to protected API endpoints, from simple API keys to OAuth2 and AWS SigV4.

Auth Types Overview

Ingestics supports the following authentication methods. Credentials are stored AES-encrypted with a unique random IV by default.

Method	Tier	Notes
No Auth (public endpoints)	Free+	No credentials needed.
API Key (header or query param)	Free+	Enter the key name and value.
Bearer Token	Free+	Sent as `Authorization: Bearer <token>`.
Basic Auth	Free+	Username + password, base64-encoded automatically.
OAuth2 Client Credentials	Lite+	Ingestics fetches and refreshes the access token using client ID + secret.
OAuth2 Auth Code + Auto-Refresh	Pro+	Full authorization code flow with automatic token refresh before expiry.
AWS Signature V4 (SigV4)	Business	For AWS API Gateway and other SigV4-protected endpoints.

Client Credentials (Lite+):

In the provider’s auth settings, select OAuth2 — Client Credentials as the auth type.
Enter the Token URL, Client ID, and Client Secret (stored AES-encrypted).
Optionally enter a Scope if required by the API.
Click Fetch Token. Ingestics fetches an access token before each scheduled fetch and caches it until expiry.

Auth Code + Auto-Refresh Pro+:

Select OAuth2 — Auth Code.
Enter the Authorization URL, Token URL, Client ID, Client Secret, and Redirect URI. The admin panel provides an OAuth callback handler — copy the displayed redirect URI into your OAuth app’s settings.
Click Authorize to complete the OAuth2 flow in a popup. Ingestics stores the refresh token securely.
Access tokens are refreshed automatically before expiry on subsequent fetches — no manual re-authorization needed.

AWS Signature Version 4 is required for AWS API Gateway endpoints and other AWS services.

Select AWS SigV4 as the auth type.
Enter your AWS Access Key ID, Secret Access Key, Region, and Service (e.g. execute-api).
Ingestics signs each request with a fresh SigV4 signature at fetch time.