Actions6
- 🏭 Partner Actions
- 🏣 Company Actions
Overview
This node integrates with the AvantGuard Phin Security API to retrieve report links related to a specific company. It is designed to fetch URLs or references to reports associated with a company identified by given partner and company IDs. This functionality is useful in scenarios where users need to programmatically access security or compliance reports for companies managed under a partner account.
Practical examples include:
- Automatically retrieving latest security audit reports for a company.
- Integrating company report links into dashboards or notification systems.
- Fetching report URLs as part of a larger workflow that processes company data.
Properties
Name | Meaning |
---|---|
Partner Id | The identifier of the partner under which the company is registered. Required to specify the context for the company. |
Company Id | The unique identifier of the company for which report links are requested. |
Output
The node outputs JSON data containing the report links related to the specified company. The exact structure depends on the API response but typically includes URLs or identifiers pointing to various company reports.
If the API supports binary data (e.g., downloadable report files), the node would handle this accordingly, but based on the provided code and properties, the primary output is JSON with report link information.
Dependencies
- Requires an API key credential for authenticating with the AvantGuard Phin Security API.
- Connects to the base URL
https://api.phinsec.io
. - Uses HTTP headers specifying JSON content type and acceptance.
- Depends on the external package
@avantguardllc/n8n-openapi-node
for building request properties from the OpenAPI specification.
Troubleshooting
- Missing or invalid Partner Id or Company Id: Ensure both IDs are correctly provided and valid; otherwise, the API may return errors or empty results.
- Authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
- Network or API availability issues: Check connectivity to
https://api.phinsec.io
and confirm the service is operational. - Unexpected API responses: If the output JSON structure changes, update workflows accordingly.
Links and References
- AvantGuard Phin Security API Documentation (assumed base URL)
- n8n documentation on Creating Custom Nodes