n8n-nodes-nvk-call-api 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +152 -0
- package/dist/nodes/NvkBrowserApi/NvkBrowserApi.description.d.ts +2 -0
- package/dist/nodes/NvkBrowserApi/NvkBrowserApi.description.js +1136 -0
- package/dist/nodes/NvkBrowserApi/NvkBrowserApi.node.d.ts +5 -0
- package/dist/nodes/NvkBrowserApi/NvkBrowserApi.node.js +308 -0
- package/dist/nodes/NvkBrowserApi/nvk.svg +63 -0
- package/package.json +53 -0
package/README.md
ADDED
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# n8n-nodes-nvk-browser
|
|
2
|
+
|
|
3
|
+
This is an n8n community node that provides integration with NVK Browser automation API. It allows you to control browser profiles, interact with web pages, capture network traffic, and execute JavaScript code programmatically.
|
|
4
|
+
|
|
5
|
+
[n8n](https://n8n.io/) is a [fair-code licensed](https://docs.n8n.io/reference/license/) workflow automation platform.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
Follow the [installation guide](https://docs.n8n.io/integrations/community-nodes/installation/) in the n8n community nodes documentation.
|
|
10
|
+
|
|
11
|
+
### Community Node Installation
|
|
12
|
+
|
|
13
|
+
1. Go to **Settings > Community Nodes** in your n8n instance
|
|
14
|
+
2. Click **Install** and enter: `n8n-nodes-nvk-browser`
|
|
15
|
+
3. Click **Install**
|
|
16
|
+
|
|
17
|
+
### Manual Installation
|
|
18
|
+
|
|
19
|
+
For local development:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npm install n8n-nodes-nvk-browser
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Operations
|
|
26
|
+
|
|
27
|
+
### Profile Management
|
|
28
|
+
|
|
29
|
+
- **Create Profile**: Create a new browser profile with proxy and extensions
|
|
30
|
+
- **Delete Profile**: Delete an existing browser profile
|
|
31
|
+
- **Start Profile**: Start a browser profile with custom window settings
|
|
32
|
+
- **Stop Profile**: Stop a running browser profile
|
|
33
|
+
- **Update Profile**: Update profile settings (name, proxy, notes, extensions)
|
|
34
|
+
- **Download Browser**: Download the browser binary
|
|
35
|
+
|
|
36
|
+
### Page Interaction
|
|
37
|
+
|
|
38
|
+
- **Move and Click**: Click on elements using CSS selectors or Puppeteer locators
|
|
39
|
+
- **Run JavaScript**: Execute JavaScript code in the browser context
|
|
40
|
+
- **Get Network Response**: Capture and filter network requests/responses
|
|
41
|
+
- **Browser HTTP Request**: Make HTTP requests using the browser's context (cookies, headers)
|
|
42
|
+
|
|
43
|
+
## Configuration
|
|
44
|
+
|
|
45
|
+
### Environment
|
|
46
|
+
|
|
47
|
+
Choose between:
|
|
48
|
+
- **Local**: Connect to `http://localhost:3000`
|
|
49
|
+
- **Docker**: Connect to `http://host.docker.internal:3000`
|
|
50
|
+
|
|
51
|
+
### API Endpoints
|
|
52
|
+
|
|
53
|
+
The node connects to the following NVK Browser API endpoints:
|
|
54
|
+
|
|
55
|
+
- `/api/profile/create` - Create profile
|
|
56
|
+
- `/api/profile/delete` - Delete profile
|
|
57
|
+
- `/api/profile/start` - Start profile
|
|
58
|
+
- `/api/profile/stop` - Stop profile
|
|
59
|
+
- `/api/profile/update` - Update profile
|
|
60
|
+
- `/api/browser/download` - Download browser
|
|
61
|
+
- `/api/browser/action` - Move and click
|
|
62
|
+
- `/api/browser/script` - Run JavaScript
|
|
63
|
+
- `/api/browser/network` - Get network response
|
|
64
|
+
- `/api/browser/request` - Browser HTTP request
|
|
65
|
+
|
|
66
|
+
## Examples
|
|
67
|
+
|
|
68
|
+
### Create a Browser Profile
|
|
69
|
+
|
|
70
|
+
```json
|
|
71
|
+
{
|
|
72
|
+
"environment": "local",
|
|
73
|
+
"resource": "profileManagement",
|
|
74
|
+
"operation": "createProfile",
|
|
75
|
+
"profileName": "MyProfile",
|
|
76
|
+
"proxy": "http:127.0.0.1:8080:user:pass",
|
|
77
|
+
"note": "Test profile"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Start Profile and Navigate
|
|
82
|
+
|
|
83
|
+
```json
|
|
84
|
+
{
|
|
85
|
+
"environment": "local",
|
|
86
|
+
"resource": "profileManagement",
|
|
87
|
+
"operation": "startProfile",
|
|
88
|
+
"profileId": "profile_123",
|
|
89
|
+
"initialUrl": "https://example.com",
|
|
90
|
+
"headless": false
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Click an Element
|
|
95
|
+
|
|
96
|
+
```json
|
|
97
|
+
{
|
|
98
|
+
"environment": "local",
|
|
99
|
+
"resource": "pageInteraction",
|
|
100
|
+
"operation": "moveAndClick",
|
|
101
|
+
"profileId": "profile_123",
|
|
102
|
+
"selector": "button#submit",
|
|
103
|
+
"clickMethod": "puppeteer"
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Capture Network Request
|
|
108
|
+
|
|
109
|
+
```json
|
|
110
|
+
{
|
|
111
|
+
"environment": "local",
|
|
112
|
+
"resource": "pageInteraction",
|
|
113
|
+
"operation": "getNetworkResponse",
|
|
114
|
+
"profileId": "profile_123",
|
|
115
|
+
"requestFilter": "api/data",
|
|
116
|
+
"matchType": "contains"
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Requirements
|
|
121
|
+
|
|
122
|
+
- n8n version 0.198.0 or higher
|
|
123
|
+
- NVK Browser API server running on localhost:3000 or accessible via Docker
|
|
124
|
+
|
|
125
|
+
## Credentials
|
|
126
|
+
|
|
127
|
+
This node does not require any credentials as it connects directly to your local NVK Browser API server.
|
|
128
|
+
|
|
129
|
+
## Compatibility
|
|
130
|
+
|
|
131
|
+
Tested with n8n version 1.0.0+
|
|
132
|
+
|
|
133
|
+
## Resources
|
|
134
|
+
|
|
135
|
+
* [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
|
|
136
|
+
* [NVK Browser API Documentation](https://github.com/yourusername/nvk-browser-api)
|
|
137
|
+
|
|
138
|
+
## Version History
|
|
139
|
+
|
|
140
|
+
### 1.0.0
|
|
141
|
+
- Initial release
|
|
142
|
+
- Support for all 10 core operations
|
|
143
|
+
- Environment selection (Local/Docker)
|
|
144
|
+
- Binary file upload support
|
|
145
|
+
|
|
146
|
+
## License
|
|
147
|
+
|
|
148
|
+
[MIT](LICENSE.md)
|
|
149
|
+
|
|
150
|
+
## Support
|
|
151
|
+
|
|
152
|
+
For issues and feature requests, please visit the [GitHub repository](https://github.com/yourusername/n8n-nodes-nvk-browser/issues).
|