Overview
The Toolzz Catalog Offline node retrieves information about schools and their classes from the Toolzz API. It is designed to fetch catalog data for a specific institution, supporting different environments (production, homologation, release) and paginated results. This node is useful in educational automation workflows where you need to synchronize or analyze school/class data from the Toolzz platform.
Practical examples:
- Automatically importing school and class lists into another system.
- Generating reports on available classes for a given institution.
- Keeping local databases in sync with the Toolzz catalog.
Properties
| Name | Type | Meaning |
|---|---|---|
| Play Token | String | The authentication token required to access the Toolzz API. |
| Ambiente | Options | Selects the environment (Prod, Homol, Release) to target the correct Toolzz API server. |
| Pagina | Number | Specifies the page number for paginated catalog results. |
| Instituição ID | Number | The unique identifier of the institution whose catalog data will be retrieved. |
Output
The node outputs a JSON array containing the response from the Toolzz API endpoint /playappapi/catalog/offline/{institutionId}. The structure of each item in the array depends on the API's response, but typically includes details about schools and their classes.
Example output structure:
[
{
// School and class data as returned by the Toolzz API
}
]
Note: The node does not output binary data.
Dependencies
- External Service: Requires access to the Toolzz API at one of the specified environments.
- Authentication: A valid Play Token is required.
- n8n Configuration: No special credentials are configured via n8n; the Play Token is provided as a property.
Troubleshooting
- Invalid Play Token: If the Play Token is missing or incorrect, the API will likely return an authentication error. Ensure the token is valid and has sufficient permissions.
- Institution Not Found: If the Instituição ID does not exist, the API may return a "not found" error. Double-check the ID value.
- Network/Environment Issues: Selecting the wrong environment (Ambiente) or network issues can cause connection errors. Verify the selected environment and network connectivity.
- Pagination Errors: If the Pagina value is out of range, the API may return empty results or an error.
Common error messages:
401 Unauthorized: Check your Play Token.404 Not Found: Verify the Instituição ID and endpoint URL.Connection refusedorENOTFOUND: Check the Ambiente selection and network access.