Commanders Act icon

Commanders Act

Use the Commanders Act API

Actions83

Overview

This node integrates with the Commanders Act API, specifically enabling the creation of a Web Constraint within the Web Container resource. It allows users to define constraints for web containers by sending structured data to the API. This is useful in scenarios where you want to programmatically manage web container constraints such as access rules, filtering conditions, or other restrictions applied to web containers managed via Commanders Act.

Practical examples include:

  • Automating the setup of web constraints during deployment pipelines.
  • Dynamically creating constraints based on external triggers or data.
  • Managing multiple web container constraints centrally through n8n workflows.

Properties

Name Meaning
Query Parameters A collection of optional query parameters to customize the API request. These include various filters, pagination, sorting options, date ranges, and tokens. Examples: end, filter[begin_date], granularity, page, sort, token.
Request Body JSON object representing the body of the POST request to create the web constraint. This should contain the details of the web constraint to be created according to the API specification.

Details on Query Parameters Options (examples):

  • End: End date/time filter.
  • Fields[template]: Template fields selection.
  • Filter: JSON filter object with subfields like begin_date, end_date, search, segment_id, etc.
  • Granularity: Level of detail for returned data.
  • Page: Pagination information in JSON format.
  • Sort: Sorting criteria, can be JSON or string depending on context.
  • Token: Authentication token or session token if required.

Output

The node outputs the JSON response from the Commanders Act API after attempting to create the web constraint. The output structure directly reflects the API's response, which typically includes details about the newly created web constraint such as its ID, configuration, status, and any metadata provided by the API.

If the API returns no content (HTTP 204), the node outputs an object indicating "Status Code": "204 No Content".

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Commanders Act API.
  • Needs valid API credentials including a site identifier and an API token.
  • The node uses HTTP requests to the base URL https://api.commander1.com/v2.
  • Proper configuration of the API credential in n8n is necessary before use.

Troubleshooting

  • Missing Credentials Error: If the API credentials are not set or invalid, the node will throw an error indicating missing credentials. Ensure that the API key/token and site ID are correctly configured.
  • Required Parameter Missing: The node checks for required IDs or parameters depending on the operation. For creating a web constraint, ensure the request body is properly formed; otherwise, the API may reject the request.
  • API Errors: Any errors returned by the API are wrapped and thrown as node errors with messages prefixed by "Error calling Commanders Act API". Check the message and stack trace for details.
  • Invalid JSON in Request Body: The request body must be valid JSON. Invalid JSON will cause parsing errors.
  • Network Issues: Connectivity problems to the API endpoint will result in request failures.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion