uSign Node icon

uSign Node

Interage com a API do uSign

Overview

This node integrates with the uSign API to perform CRUD operations on specified entities. It supports listing multiple records, retrieving a single record by ID, deleting a record by ID, and updating a record by ID with new JSON data.

A common use case is automating document or entity management workflows where you need to programmatically fetch, update, or delete records in uSign. For example, you might use it to delete a specific contract or document by its ID after certain conditions are met in your workflow.

The "Apagar" (Delete) operation specifically deletes a resource identified by an entity name and an ID, which is useful for removing unwanted or obsolete records from uSign.

Properties

Name Meaning
Operation The action to perform: Listar (list), Resgatar (get), Apagar (delete), Alterar (put).
Entity Name or ID The name of the entity type or its identifier to operate on (required).
ID The unique identifier of the resource to get, delete, or update (required for these ops).

For the "Apagar" operation, you must provide:

  • Entity Name or ID: The target entity type.
  • ID: The specific resource ID to delete.

Output

The node outputs an array of items, each containing a json property with the response data from the uSign API:

  • For the "Apagar" (delete) operation, the output's json field contains the API's response confirming deletion or providing related information.
  • No binary data is produced by this node.

Example output structure for delete operation:

[
  {
    "json": {
      // API response confirming deletion
    }
  }
]

Dependencies

  • Requires an active connection to the uSign API.
  • Needs credentials including username, password, and base URL for the uSign API.
  • The node authenticates by obtaining a bearer token via a login endpoint before making requests.
  • Uses HTTP methods POST (for login), DELETE (for delete), GET, and PUT accordingly.

Troubleshooting

  • Authentication errors: If login fails, check that the provided username, password, and base URL are correct and that the API is reachable.
  • Invalid operation error: Selecting an unsupported operation will throw an error indicating an invalid operation.
  • Resource not found: Deleting a non-existent ID may result in an error from the API; verify the entity name and ID are correct.
  • JSON parsing errors: For update operations, ensure the JSON data is valid and correctly formatted.
  • Rate limits or network issues: Network failures or API rate limiting can cause request errors; retry or check API status.

Links and References

Discussion