npm package: @kepha/n8n-nodes-kepha
Description: Kepha nodes for n8n
Author: Jeferson Souza
Latest version: 1.2.0

# @kepha/n8n-nodes-kepha

<p align="center">
  <img src="./nodes/kepha.svg" width="100" alt="Kepha Logo"/>
</p>

This is an **n8n community node** that lets you interact with the **Kepha API** in your n8n workflows.

[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.

![npm version](https://img.shields.io/npm/v/@kepha/n8n-nodes-kepha)
![License](https://img.shields.io/npm/l/@kepha/n8n-nodes-kepha)

## Table of Contents

- [Installation](#installation)
- [Resources & Operations](#resources--operations)
- [Credentials](#credentials)
- [Usage](#usage)
- [Compatibility](#compatibility)
- [Resources](#resources)
- [License](#license)

## Installation

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

### Using the n8n UI

1. Go to **Settings** > **Community Nodes**
2. Click **Install a community node**
3. Enter `@kepha/n8n-nodes-kepha`
4. Click **Install**

### Using npm (for self-hosted)

```bash
npm install @kepha/n8n-nodes-kepha
```

## Resources & Operations

The **Kepha** node is organized by resources. Each resource has its own set of operations:

### 📋 Whitelist

Manage phone number whitelist entries using the internal API.

| Operation | Description |
|-----------|-------------|
| **Check** | Check if phone is in whitelist |
| **Create** | Add a phone number to whitelist |
| **Delete** | Remove a phone number from whitelist (by ID) |

#### Phone Number Format

Phone numbers must be in international format:

```
+[country_code][number]
```

**Example:** `+5511999998888` (Brazil)

---

*More resources coming soon!*

## Credentials

To use this node, you need to configure the **Kepha API** credentials:

| Field | Description |
|-------|-------------|
| **API Key** | Your Kepha X-Api-Key |
| **API Base URL** | The base URL of the Kepha API |

## Usage

1. **Install** the community node in your n8n instance
2. **Add credentials**: Go to Credentials > New > Search for "Kepha API"
3. **Configure** your API Key and base URL
4. **Add the node**: Search for "Kepha" in the nodes panel
5. **Select resource** (e.g., Whitelist)
6. **Select operation** and configure the required parameters

### Example Workflow

```
[Trigger] → [Kepha: Whitelist - Check] → [If: Found?] → [Output]
```

The node displays a helpful subtitle showing the selected resource and operation:
```
Kepha
Whitelist: Check
```

## Compatibility

- **n8n version**: Tested with n8n v1.0.0 and above
- **Node.js**: v18.x or higher recommended

## Resources

- [n8n Community Nodes Documentation](https://docs.n8n.io/integrations/community-nodes/)
- [Kepha API Documentation](https://authenticator-acggbjbzhdgsdrh8.westus-01.azurewebsites.net/v3/api-docs)

## Development

```bash
# Clone the repository
git clone https://github.com/kepha/n8n-nodes-kepha.git

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode (watch)
npm run dev

# Run tests
npm test

# Lint code
npm run lint

# Format code
npm run format
```

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

## Support

- 📧 **Email**: [souzjfe@gmail.com](mailto:souzjfe@gmail.com)
- 🐛 **Issues**: [GitHub Issues](https://github.com/kepha/n8n-nodes-kepha/issues)

---

<p align="center">
  Made with ❤️ by <a href="https://github.com/kepha">Kepha</a>
</p>