Overview
This node facilitates interaction with the Zalo API, specifically enabling users to generate and manage Zalo credentials via QR code scanning and API calls. It is designed to automate the creation and management of Zalo user credentials within n8n workflows.
Common scenarios where this node is beneficial include:
- Automating login and authentication processes for Zalo accounts.
- Managing multiple Zalo credentials programmatically.
- Integrating Zalo user data retrieval into larger automation workflows.
- Generating QR codes for Zalo login that can be scanned to authenticate users.
Practical example:
- A workflow that listens for a Zalo QR code scan event, automatically creates or updates the corresponding Zalo credential in n8n, and then uses that credential to perform further actions such as sending messages or retrieving user info.
Properties
| Name | Meaning |
|---|---|
| Proxy | HTTP proxy URL to route Zalo API requests through (e.g., https://user:pass@host:port). |
Output
The node outputs an array of items, each containing:
json:
success(boolean): Indicates if the operation was successful.message(string): Describes the result, e.g., whether a QR code was generated successfully or if an existing credential is used.fileName(string): The filename of the generated QR code image (zalo-qr-code.png).usingExistingCredential(boolean): Whether an existing credential was used instead of creating a new one.credentialType(string|null): The type of credential used or created (generic description).credentialName(string, optional): The name of the credential if available.credentialId(string, optional): The ID of the credential if available.credentialInstructions(string, optional): Instructions related to the credential creation process.
binary:
data: Contains the binary data of the generated QR code image, which can be used for display or further processing.
Dependencies
- Requires access to the Zalo API, which involves using an API key credential configured in n8n.
- Optionally supports routing requests through an HTTP proxy.
- Uses internal helper libraries for handling QR code events, API communication, and file system operations.
- Requires n8n environment to have permissions to write/read files for storing credentials and user data.
Troubleshooting
Common Issues
- Timeout waiting for QR code scan: If the QR code is not scanned within a certain timeout period (~30 seconds), the node throws a timeout error. Ensure the QR code is scanned promptly.
- Invalid or missing API credentials: The node requires valid API credentials to communicate with the Zalo API. Missing or incorrect credentials will cause authentication failures.
- Proxy misconfiguration: If using a proxy, ensure the proxy URL is correctly formatted and accessible.
- File system permission errors: The node reads/writes JSON files to store credentials and user data. Lack of proper file system permissions may cause errors.
Error Messages and Resolutions
- "Timeout waiting for QR code scan": Increase timeout or ensure the QR code is scanned quickly.
- API request errors with status 403 or 401: Check API key validity and permissions.
- "Error saving credentials": Verify that the n8n process has write permissions to the directory where credentials are stored.
- "No context found in api object": Indicates failure to retrieve user context from the API; check network connectivity and API availability.
Links and References
- Zalo Official API Documentation (for understanding API endpoints and authentication)
- n8n Documentation (for general node development and credential management)
- QR Code Generation and Usage (background on QR codes used for authentication)
Note: This summary is based solely on static analysis of the provided source code and does not execute or simulate runtime behavior.