Skip to content

mayo3030/n8n-api-client

Repository files navigation

n8n API Client

مكتبة JavaScript شاملة للتفاعل مع n8n API مباشرة من Cursor أو أي بيئة Node.js.

المميزات

  • ✅ إدارة كاملة لـ Workflows (إنشاء، قراءة، تحديث، حذف)
  • ✅ تنفيذ Workflows
  • ✅ إدارة Executions
  • ✅ إدارة Credentials
  • ✅ معالجة شاملة للأخطاء
  • ✅ دعم كامل لجميع عمليات n8n API

التثبيت

npm install

الإعداد

  1. قم بإنشاء ملف .env في المجلد الرئيسي للمشروع:
N8N_URL=https://your-n8n-instance.com
N8N_API_KEY=your-api-key-here

ملاحظة: احصل على مفتاح API من إعدادات n8n > API. يمكنك استخدام ملف .env.example كقالب.

الاستخدام

استيراد المكتبة

import N8nClient from './n8n-client.js';

const n8n = new N8nClient();

أمثلة الاستخدام

جلب جميع Workflows

const workflows = await n8n.getAllWorkflows();
console.log(workflows);

جلب Workflow محدد

const workflow = await n8n.getWorkflow('workflow-id');
console.log(workflow);

إنشاء Workflow جديد

const newWorkflow = await n8n.createWorkflow({
  name: 'My New Workflow',
  nodes: [...],
  connections: {},
  active: false
});

تحديث Workflow

const updated = await n8n.updateWorkflow('workflow-id', {
  name: 'Updated Name',
  active: true
});

حذف Workflow

await n8n.deleteWorkflow('workflow-id');

تفعيل/تعطيل Workflow

await n8n.activateWorkflow('workflow-id');
await n8n.deactivateWorkflow('workflow-id');

تنفيذ Workflow

const result = await n8n.executeWorkflow('workflow-id', {
  inputData: 'your data here'
});

جلب Executions

const executions = await n8n.getExecutions({
  workflowId: 'workflow-id',
  limit: 10
});

إدارة Credentials

// جلب جميع credentials
const credentials = await n8n.getAllCredentials();

// إنشاء credential جديد
const credential = await n8n.createCredential({
  name: 'My Credential',
  type: 'httpBasicAuth',
  data: { ... }
});

اختبار الاتصال

const isConnected = await n8n.testConnection();
console.log(isConnected); // true or false

جلب الإحصائيات

const stats = await n8n.getStats();
console.log(stats);
// {
//   totalWorkflows: 10,
//   activeWorkflows: 5,
//   hasExecutions: true
// }

تشغيل الأمثلة

node example.js

الوثائق الكاملة

جميع الوظائف متاحة في ملف n8n-client.js مع توثيق كامل بالعربية.

الأمان

⚠️ مهم:

  • لا ترفع ملف .env إلى Git. تم إضافته تلقائياً إلى .gitignore.
  • استخدم GitHub Secrets لحفظ المعلومات الحساسة في CI/CD.
  • استخدم متغيرات البيئة في الإنتاج.

الترخيص

MIT

About

JavaScript API client for n8n workflow automation and integration tasks.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors