Nuvem SolutionInstall

Overview

This node integrates with the Nuvem Solution API to perform various operations across multiple resources. Specifically, for the resource "Ordem de Serviço" (Service Order), it supports operations such as creating a complete service order, retrieving service orders by ID or external code, listing schedules and lock statuses, including appointments, expenses, parts, services, observations, and editing parts, services, or vehicles associated with a service order.

The "Consultar por Código Externo" operation allows users to retrieve detailed information about a service order using an external code identifier. This is useful when you have an external reference code for a service order and want to fetch its details without knowing the internal system ID.

Practical scenarios:

• Automating retrieval of service order details from an external system that uses its own codes.
• Integrating service order data into workflows where only external codes are available.
• Synchronizing service order status or details between systems based on external references.

Properties

Output

The node outputs JSON data representing the service order details retrieved from the Nuvem Solution API. The structure corresponds to the service order object returned by the API endpoint /erp/oficina/ordensServico/codigoExterno/{codigoExterno}.

Typical output fields may include identifiers, customer info, vehicle details, status, dates, items (parts and services), expenses, appointments, and observations related to the service order.

No binary data output is indicated for this operation.

Dependencies

• Requires an API key credential for authenticating with the Nuvem Solution API.
• The node expects credentials containing:
  • Base URL of the API
  • Software key
  • Secret
  • User ID
  • User key
• These credentials must be configured in n8n before using the node.
• The node makes HTTP requests to the Nuvem Solution API endpoints.

Troubleshooting

• Authentication errors: If authentication fails, verify that the API credentials (software key, secret, user ID, user key) are correct and active.
• Invalid external code: If the provided external code does not exist or is incorrect, the API will likely return an error or empty response. Double-check the code value.
• Network issues: Ensure that the n8n instance can reach the Nuvem Solution API base URL.
• API changes: If the API endpoint or response format changes, the node might fail or return unexpected data.
• Error messages: The node throws errors if the operation or resource is unsupported or if required parameters are missing.

To resolve errors:

• Confirm all required input properties are set.
• Check API credentials and permissions.
• Review API documentation for any updates.
• Enable "Continue On Fail" in n8n to handle errors gracefully in workflows.

Links and References

• Nuvem Solution API Documentation (general reference; specific docs may require access)
• n8n Documentation: Creating Custom Nodes
• REST API concepts: RESTful API Design

If you need summaries for other resources or operations, please provide their names.