HAP icon

HAP

Interact with HAP (Hyper Application Platform) API

Actions31

Overview

This node interacts with the HAP (Hyper Application Platform) API to retrieve a shareable link for a specific record within a worksheet. The "Get Share Link" operation under the "Record" resource allows users to generate a URL that can be shared externally or internally, providing access to the record data with optional restrictions such as expiration time, visible fields, and password protection.

Common scenarios where this node is beneficial include:

  • Sharing a single record's data securely with external stakeholders without exposing the entire dataset.
  • Generating temporary access links for collaborators or clients.
  • Controlling visibility of sensitive fields by specifying which fields are visible in the shared link.
  • Protecting shared links with passwords for added security.

Practical example:

  • A project manager wants to share the status of a particular task (record) with a client but only wants to expose certain fields like "Task Name," "Due Date," and "Status." They use this node to generate a share link with those visible fields, set an expiration time of 24 hours, and add a password for access control.

Properties

Name Meaning
Worksheet ID The unique identifier of the worksheet containing the record.
Record ID The unique row ID of the record to generate the share link for.
Expired In (Seconds) Duration in seconds for which the share link remains valid. Use 0 for a permanent link.
Visible Fields JSON array of field IDs that should be visible when accessing the share link.
Password Optional password required to access the share link. Leave empty for no password protection.

Output

The node outputs JSON data containing the generated share link information. The key output field json includes at least the URL of the share link, which can be used to access the record according to the specified parameters (visibility, expiration, password).

If the node supports binary data output, it is not indicated here; thus, the output is primarily JSON-based.

Dependencies

  • Requires an API key credential for authenticating with the HAP API.
  • The node expects proper configuration of the HAP API credentials within n8n.
  • Network connectivity to the HAP API endpoint is necessary.

Troubleshooting

  • Invalid Worksheet ID or Record ID: If the provided IDs do not exist or are incorrect, the API will likely return an error indicating the resource was not found. Verify the IDs before running the node.
  • Expired In value issues: Setting a negative expiration time or invalid number may cause errors. Ensure the expiration time is zero or a positive integer.
  • Permission Denied: If the API key does not have sufficient permissions to access the worksheet or record, the node will fail. Check API key scopes and user permissions.
  • Password Issues: If a password is set but not provided when accessing the share link, access will be denied. Make sure to communicate the password to intended recipients.
  • Network or Authentication Errors: Common HTTP errors like 401 Unauthorized or 403 Forbidden indicate credential or permission problems. Recheck API key validity and configuration.

Links and References

Discussion