Consultorio Live icon

Consultorio Live

Interagir com a API do Consultorio Live para gestão de clínicas e consultórios
Join our community

Actions20

Overview

This node integrates with the Consultorio Live API, a platform for managing clinics and medical offices. Specifically, the "Agendamento" (Appointment) resource with the "Obter" (Get) operation allows users to retrieve detailed information about a specific appointment by its ID. This is useful in scenarios where you need to fetch appointment details for display, processing, or further automation within a healthcare workflow.

Practical examples include:

  • Fetching appointment details to confirm scheduling before sending reminders.
  • Retrieving appointment data to update patient records or billing systems.
  • Integrating appointment information into dashboards or reports.

Properties

Name Meaning
ID Do Agendamento The unique identifier of the appointment to retrieve. This is a required string input.

Output

The node outputs JSON data representing the appointment details fetched from the Consultorio Live API. The structure typically includes fields such as appointment date/time, patient information, professional assigned, status, and other relevant metadata related to the appointment.

If the API supports binary data for this resource (not indicated here), it would be summarized accordingly, but based on the provided code and context, the output is JSON only.

Dependencies

  • Requires an API key credential for authenticating with the Consultorio Live API.
  • The base URL for the API is configured via credentials.
  • The node sends HTTP requests with JSON content type and expects JSON responses.

Troubleshooting

  • Missing or invalid appointment ID: Ensure that the "ID Do Agendamento" property is provided and correctly formatted; otherwise, the API will likely return an error indicating a missing or invalid identifier.
  • Authentication errors: Verify that the API key credential is correctly set up and has the necessary permissions.
  • Network or API errors: Check connectivity and API availability. Errors returned by the API should be inspected for details.
  • Unexpected response structure: If the API changes, the node's output format might differ; verify against the latest API documentation.

Links and References

Discussion