Overview
This node integrates with the uSign API to perform CRUD operations on various entities. It supports listing multiple records, retrieving a single record by ID, deleting a record, and updating a record with new JSON data.
Common scenarios include:
- Fetching lists of documents or users managed in uSign.
- Retrieving detailed information about a specific resource.
- Deleting obsolete or incorrect entries.
- Updating existing resources with new data.
For example, you could use this node to update the details of a contract by providing its entity name, ID, and the updated JSON content.
Properties
| Name | Meaning |
|---|---|
| Operation | The action to perform: Listar (list), Resgatar (get), Apagar (delete), Alterar (put). |
| Load All Records | Whether to load all records when listing (only for Listar operation). |
| Limit | Maximum number of results to return when listing (only for Listar operation). |
| All Subdomains | Whether to include all subdomains in the listing (only for Listar operation). |
| Entity Name or ID | The name of the entity to operate on (required). |
| ID | The ID of the resource (required for get, delete, and put operations). |
| JSON Data | The new JSON data to update the resource with (required for put operation). |
Output
The node outputs an array of items where each item contains a json field holding the response data from the uSign API:
- For Listar (list) operation: An array of JSON objects representing the listed entities.
- For Resgatar (get) operation: A single JSON object with the resource details.
- For Apagar (delete) operation: A JSON object indicating the result of the deletion.
- For Alterar (put) operation: A JSON object with the updated resource data.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the uSign API.
- Uses the Axios HTTP client library to make REST API calls.
- Needs network access to the configured uSign API base URL.
- The node expects credentials containing username, password, and base URL for the uSign API.
Troubleshooting
- Invalid Operation Error: If an unsupported operation is selected, the node throws an "Operação inválida" error. Ensure the operation is one of the supported options.
- Request Errors: Network issues or invalid credentials can cause request failures, resulting in errors like "Erro na requisição:
". Verify API credentials and network connectivity. - JSON Parsing Errors: For the update operation, the JSON data must be valid JSON. Invalid JSON will cause parsing errors.
- Missing Required Parameters: The node requires the entity name and, depending on the operation, the resource ID or update JSON. Missing these will cause errors.
Links and References
- uSign API Documentation (example link; replace with actual if available)
- Axios HTTP Client
- n8n Node Development Documentation