npm package: @roftebro88/n8n-nodes-cloudradial
Description: N8n community node for Cloud Radial API
Author: roftebro88
Latest version: 0.3.6

# n8n-nodes-cloudradial

This is an n8n community node for the Cloud Radial API. It lets you interact with Cloud Radial resources in your n8n workflows.

[Cloud Radial](https://cloudradial.com/) is a client portal and service management platform designed for MSPs (Managed Service Providers).

## Installation

Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.

## Credentials

To use this node, you need:

1. A Cloud Radial account
2. API credentials (Public Key and Private Key) from Cloud Radial
3. Your Cloud Radial API URL (e.g., `https://api.us.cloudradial.com` or `https://api.eu.cloudradial.com`)

### Setting Up Credentials

1. Log in to your Cloud Radial portal
2. Navigate to API settings to generate your Public Key and Private Key
3. In n8n, create new "Cloud Radial API" credentials
4. Enter your API URL, Public Key, and Private Key

## Supported Resources

This node provides access to the following Cloud Radial resources:

- **Archive Items** - Manage archived documents and files
- **Articles** - Knowledge base articles
- **Assessment** - Security assessments and evaluations
- **Catalog** - Service catalog items and requests
- **Catalog Question** - Questions for catalog item requests
- **Companies** - Customer/client organizations
- **Courses** - Training courses
- **Course Enrollments** - User course enrollments
- **Domains** - Domain management
- **Endpoints** - Devices and workstations
- **Flexible Assets** - Custom asset types
- **Flexible Asset Types** - Asset type definitions
- **Media** - Media file management
- **Services** - Service catalog items
- **Service Installs** - Services installed on endpoints
- **Tokens** - API token management
- **Users** - User accounts

## Operations

Each resource supports standard CRUD operations where applicable:

- **Get** - Retrieve a single item by ID
- **Get Many** - Retrieve multiple items with OData filtering
- **Create** - Create a new item
- **Update** - Update an existing item
- **Delete** - Delete an item

## OData Support

Most "Get Many" operations support OData query parameters for advanced filtering, sorting, and pagination:

- `$filter` - Filter results (e.g., `name eq 'Acme Corp'`)
- `$select` - Choose specific fields to return
- `$orderby` - Sort results (e.g., `name asc`)
- `$top` - Limit number of results
- `$skip` - Skip results for pagination

## Examples

### Get all companies
- Resource: Company
- Operation: Get Many

### Get endpoints for a specific manufacturer
- Resource: Endpoint
- Operation: Get Many
- OData Filter: `manufacturer eq 'Dell'`

### Create a new user
- Resource: User
- Operation: Create
- Provide email, firstName, lastName

## API Documentation

For detailed information about the Cloud Radial API, visit:
- [Cloud Radial API Documentation](https://developers.cloudradial.com/v2/reference/)
- [Legacy Swagger Documentation](https://api.us.cloudradial.com/swagger/index.html)

## Tips

### Avoiding API Call Loops
- **Important**: Make sure your functions are set to run one time as to not create an API call loop
- When configuring workflows, be careful with trigger nodes that may cause repeated API calls
- Use appropriate polling intervals and execution limits to prevent excessive API usage

## Recent Fixes

### Version 0.3.x
- **Catalog API Now Working**: Cloud Radial has resolved API issues with Catalog and Catalog Question endpoints - all operations now functioning correctly
- **Fixed API Authentication**: Updated authentication from Bearer token to Public Key / Private Key headers
- **Added Catalog Resources**: Added comprehensive Catalog and Catalog Question resources with 50+ fields
- **Fixed TypeScript Compilation Errors**:
  - Fixed send configuration in multiple description files (changed `properties` to `property: 'odataOptions'`)
  - Added missing Fields exports to 6 description files
  - Completed incomplete ArticleDescription.ts file
  - Fixed OData query options in ArchiveDescription.ts
  - Corrected postReceive output sections across all resources
- **Added New Resources**: Assessment, Domain, and Media resources
- **Improved OData Support**: Consistent OData v4 query support across all "Get Many" operations

## Known Issues

### Authentication Method
- **Note**: API documentation suggests Basic Auth (username/password as GUIDs) may be the preferred method
- **Current Implementation**: Using Public Key / Private Key headers
- **Status**: Works for most endpoints, but may need updating in future versions

## Version History

### 0.3.6 (Latest)
- Updated documentation: Catalog API endpoints now fully functional (Cloud Radial resolved API issues)
- Added Tips section with guidance on avoiding API call loops
- Removed resolved Catalog API issue from Known Issues

### 0.3.5
- Removed homepage field from package metadata

### 0.3.4
- Updated Known Issues documentation

### 0.3.3
- Removed repository links from package metadata

### 0.3.2
- Updated README with comprehensive fixes and known issues sections

### 0.3.1
- Fixed TypeScript compilation errors
- Added missing Fields exports
- Improved OData support across all resources
- Build and publish fixes

### 0.3.0
- Added Catalog and Catalog Question resources
- Fixed API authentication (Bearer token → Public/Private Key)
- Added Assessment, Domain, and Media resources
- Fixed send configuration in multiple description files
- Completed ArticleDescription.ts implementation

### 0.2.x
- Authentication improvements
- Bug fixes and enhancements

### 0.1.0
- Initial release
- Support for 12 major resources
- Full CRUD operations
- OData query support

## License

MIT

## Resources

* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
* [Cloud Radial](https://cloudradial.com/)