n8n-nodes-epic/README.md

n8n community nodes for Applied Epic API

# n8n-nodes-epic

This is an n8n community node package for the Applied Epic API. It provides nodes to interact with Epic's insurance platform APIs.

![n8n.io - Workflow Automation](https://raw.githubusercontent.com/n8n-io/n8n/master/assets/n8n-logo.png)

## Installation

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

1. Go to **Settings > Community Nodes**.
2. Select **Install**.
3. Enter `n8n-nodes-epic` as the package name.
4. Agree to the [risks](https://docs.n8n.io/integrations/community-nodes/risks/) of using community nodes: select **I understand the risks of installing unverified code from a public source**.
5. Select **Install**.

After the package is installed, you can access the Epic node in your n8n instance.

## Features

This package provides access to multiple Epic API resources:

- **Accounts** - Manage top-level account data
- **Attachments** - Handle document attachments
- **Clients** - Manage client information and benefits
- **Opportunities** - Work with sales opportunities
- **Organizations** - Handle organization data
- **Employees** - Manage employee information
- **Services** - Access service-related data

## Credentials

To use this node, you need to configure Epic API credentials:

1. **Environment**: Choose between Production or Mock environment
2. **Client Key**: Your Epic API client key
3. **Client Secret**: Your Epic API client secret

The node uses OAuth 2.0 Client Credentials flow for authentication.

## Supported Operations

Each resource supports various operations like:
- Get single records by ID
- List multiple records with filtering
- Create new records (where supported)
- Update existing records (where supported)

## Configuration

### Base URLs
- **Production**: `https://api.myappliedproducts.com`
- **Mock**: `https://api.mock.myappliedproducts.com`

### Authentication
The node automatically handles OAuth 2.0 token acquisition and refresh using your provided credentials.

## Development

### Prerequisites
- Node.js 18+
- pnpm 8+

### Setup
```bash
# Install dependencies
pnpm install

# Generate nodes from OpenAPI specs
pnpm run generate

# Build the project
pnpm run build

# Run linting
pnpm run lint
```

### OpenAPI Specs
The project includes multiple OpenAPI specifications in the `openapi-specs/Epic/` directory. These are automatically converted to JSON and used to generate the node properties.

## Resources

- [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
- [Applied Epic API Documentation](https://docs.myappliedproducts.com/epic)

## License

MIT

## Version History

### 0.1.0
- Initial release with support for basic Epic API resources
- OAuth 2.0 Client Credentials authentication
- Support for Account, Client, Attachment, Opportunity, and Organization resources