API Обзор

n8n предоставляет REST API для программного управления воркфлоу и выполнениями.

Базовая информация

Base URL: https://n8n.chapiro.space/api/v1

Формат: JSON

Аутентификация: API Key

Быстрый старт

Получение API ключа

1. Войдите в n8n
2. Перейдите в "Settings" → "API"
3. Нажмите "Create API Key"
4. Скопируйте ключ (показывается только один раз!)

Первый запрос

curl -X GET https://n8n.chapiro.space/api/v1/workflows \
  -H "X-N8N-API-KEY: your_api_key_here"

Ответ:

{
  "data": [
    {
      "id": "1",
      "name": "My Workflow",
      "active": true,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-20T15:30:00.000Z"
    }
  ]
}

Основные endpoints

Workflows

Метод	Endpoint	Описание
GET	/workflows	Список всех воркфлоу
GET	/workflows/:id	Получить воркфлоу по ID
POST	/workflows	Создать новый воркфлоу
PUT	/workflows/:id	Обновить воркфлоу
DELETE	/workflows/:id	Удалить воркфлоу
POST	/workflows/:id/activate	Активировать воркфлоу
POST	/workflows/:id/deactivate	Деактивировать воркфлоу

Executions

Метод	Endpoint	Описание
GET	/executions	Список выполнений
GET	/executions/:id	Получить выполнение по ID
DELETE	/executions/:id	Удалить выполнение
POST	/workflows/:id/execute	Запустить воркфлоу

Credentials

Метод	Endpoint	Описание
GET	/credentials	Список credentials
GET	/credentials/:id	Получить credential по ID
POST	/credentials	Создать credential
PUT	/credentials/:id	Обновить credential
DELETE	/credentials/:id	Удалить credential

Лимиты и ограничения

• Rate Limit: 100 запросов в минуту на API ключ
• Timeout: 30 секунд на запрос
• Max Payload: 10 MB

Обработка ошибок

HTTP коды статуса

• 200 - Успешный запрос
• 201 - Ресурс создан
• 400 - Неверный запрос
• 401 - Не авторизован
• 403 - Доступ запрещен
• 404 - Ресурс не найден
• 429 - Превышен rate limit
• 500 - Внутренняя ошибка сервера

Формат ошибки

{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "Workflow with ID '123' not found",
    "details": {
      "workflowId": "123"
    }
  }
}

Примеры использования

Python

import requests

API_KEY = "your_api_key"
BASE_URL = "https://n8n.chapiro.space/api/v1"

headers = {
    "X-N8N-API-KEY": API_KEY,
    "Content-Type": "application/json"
}

# Получить список воркфлоу
response = requests.get(f"{BASE_URL}/workflows", headers=headers)
workflows = response.json()

print(workflows)

JavaScript / Node.js

const axios = require('axios');

const API_KEY = 'your_api_key';
const BASE_URL = 'https://n8n.chapiro.space/api/v1';

const api = axios.create({
  baseURL: BASE_URL,
  headers: {
    'X-N8N-API-KEY': API_KEY
  }
});

// Получить список воркфлоу
async function getWorkflows() {
  const response = await api.get('/workflows');
  return response.data;
}

getWorkflows().then(console.log);

PHP

<?php

$apiKey = 'your_api_key';
$baseUrl = 'https://n8n.chapiro.space/api/v1';

$ch = curl_init($baseUrl . '/workflows');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-N8N-API-KEY: ' . $apiKey
]);

$response = curl_exec($ch);
curl_close($ch);

$workflows = json_decode($response, true);
print_r($workflows);

Webhooks

Кроме REST API, n8n поддерживает webhooks для получения событий.

Создание webhook воркфлоу

1. Создайте воркфлоу с "Webhook Trigger"
2. Настройте path (например, /my-webhook)
3. Активируйте воркфлоу
4. URL: https://n8n.chapiro.space/webhook/my-webhook

Отправка данных в webhook

curl -X POST https://n8n.chapiro.space/webhook/my-webhook \
  -H "Content-Type: application/json" \
  -d '{"event": "user.created", "userId": 123}'

Следующие шаги

• Аутентификация
• Endpoints документация