Erply Services
AI-generatedOverview
This node allows users to interact with Erply service APIs by making HTTP requests to specified endpoints. It is designed for flexible API consumption where the user can specify the base URL, endpoint path, HTTP method, query parameters, and request body dynamically. This node is beneficial in scenarios where you need to integrate Erply services into your workflows without a dedicated pre-built node, enabling custom API calls such as fetching data, updating records, or deleting resources.
Practical examples include:
- Retrieving product or customer data from Erply by specifying the appropriate endpoint.
- Creating or updating records using POST, PUT, or PATCH methods with JSON bodies.
- Deleting resources via DELETE requests.
- Dynamically selecting endpoints and parameters based on workflow data or expressions.
Properties
| Name | Meaning |
|---|---|
| Service Base URL | The base URL of the Erply service API to which requests will be sent. Typically the root API URL. |
| Endpoint Path Select | A dropdown list of available endpoint paths loaded dynamically based on the selected service URL. |
| Endpoint Path | The specific API endpoint path to call. Can be set directly or replaced dynamically using expressions. |
| Include Headers | Whether to include HTTP response headers in the output alongside the response body. |
| Method | The HTTP method to use for the request. Options: DELETE, GET, PATCH, POST, PUT. |
| JMES Path | An optional JMESPath expression to filter or transform the JSON response data after receiving it. |
| Body | JSON-formatted string representing the request body. Only shown and used for PATCH, POST, and PUT methods. |
| Parameters | Key-value pairs added as query string parameters to the request URL. Multiple parameters can be specified. |
Output
The node outputs the JSON response from the Erply API call under the json field. If "Include Headers" is enabled, the output includes the full HTTP response including headers. The JSON output can be filtered or transformed using the optional JMESPath expression provided in the properties.
If the API returns binary data (not typical for this node), it would be included accordingly, but this node primarily handles JSON responses.
Dependencies
- Requires an active connection to an Erply service API endpoint.
- Needs an API authentication token or key configured in n8n credentials (referred generically as an API key credential).
- Uses dynamic loading of endpoint paths based on the selected service URL.
- No additional external libraries beyond those bundled with n8n are required.
Troubleshooting
Common issues:
- Incorrect or missing base URL (
Service Base URL) causing connection failures. - Invalid endpoint paths leading to 404 errors.
- Improperly formatted JSON in the Body property causing parsing errors.
- Missing or invalid API authentication resulting in authorization errors.
- Query parameters not being appended correctly if keys or values are empty.
- Incorrect or missing base URL (
Error messages:
- "Failed to fetch" or "Network error": Check the base URL and network connectivity.
- "Invalid JSON body": Ensure the Body property contains valid JSON syntax.
- "Unauthorized" or "Forbidden": Verify that the API key or authentication credentials are correct and have sufficient permissions.
- "404 Not Found": Confirm the endpoint path is correct and exists on the server.
Links and References
- Erply API Documentation (for detailed API endpoint info)
- JMESPath Tutorial (for filtering JSON responses)
- n8n Expressions Documentation (for dynamic parameter usage)