DocsAPIs
Connect Data
APIs
Connect to a REST or GraphQL API as a data source. NNIPA calls the endpoint on your configured schedule and profiles the responses like any other source.
Quick Start
- 1
Pick an API type
Choose REST or GraphQL.
- 2
Name the source
Give it a Source Name and, optionally, a Description.
- 3
Set the connection
Provide the Base URL, and optionally a Sample Path used only for Test Connection.
- 4
Tune request settings (optional)
Set a Request Timeout, whether to verify the HTTPS certificate, and any Default Headers sent with every request.
- 5
Set authentication
Choose an Authentication Method — leave it as None for a public API, or configure credentials.
- 6
Test & save
NNIPA calls the Sample Path (or Base URL) to confirm the connection works before saving.
Connection details
Base URLThe root URL of the API, e.g. https://api.example.com/v1Sample PathA real, cheap path like /me or /health used only when you click Test Connection. Leave blank to test the base URL instead.Request TimeoutMaximum time to wait for a single request, in seconds. Default is 30.Verify HTTPS certificateLeave on for production. Turn off only when connecting to internal services with self-signed certificates.Default HeadersA JSON object sent on every request, including the sign-in request when using Username & Password authentication.Good to know
- Default Headers apply to every request, including sign-in requests for Username & Password authentication.
- Turning off HTTPS certificate verification is only safe for internal services with self-signed certificates — never do this for public endpoints.
- A missing or unreachable Sample Path will fail Test Connection even if the Base URL itself is correct — leave it blank if you're unsure.