REST API 레퍼런스

JsonPipe는 프로그래밍 방식의 워크플로우 생성, 배포, 계정 관리를 위한 REST API를 제공합니다.

기본 URL: https://api.jsonpipe.com

인증

JsonPipe는 두 가지 인증 방법을 지원합니다:

방법	용도
JWT Bearer 토큰	사용자 계정 (등록, 로그인, 결제)
X-API-Key	서버 간 통합

자세한 설정은 인증을 참조하세요.

---

공개 엔드포인트

GET /health

서비스 상태 및 버전 확인. 인증 불필요.

{
  "status": "ok",
  "version": "5.0.0",
  "env": "production",
  "grok": true,
  "database": "mariadb",
  "stripe": true
}

---

워크플로우 생성

POST /api/v1/generate

자연어로 n8n 워크플로우 생성. JWT 또는 API 키 필요.

{
  "request": "새 Gmail 이메일을 받으면 AI로 요약하고 Slack에 보내기",
  "lang": "ko"
}

응답 (200 OK):

{
  "success": true,
  "plan": "1. Gmail Trigger\n2. OpenAI (요약)\n3. Slack (게시)",
  "workflow": {
    "name": "Gmail AI 요약 to Slack",
    "nodes": [...],
    "connections": {...}
  },
  "nodes": [
    { "name": "Gmail Trigger", "type": "gmailTrigger" },
    { "name": "OpenAI", "type": "openAi" },
    { "name": "Slack", "type": "slack" }
  ],
  "generationMode": "sequential"
}

참고: generationMode는 Free/Starter 플랜에서는 "sequential", Pro/Team/Enterprise 플랜에서는 "parallel" (3배 빠름)입니다.

---

워크플로우 배포

POST /api/v1/deploy

생성된 워크플로우를 n8n 인스턴스에 직접 배포. JWT 또는 API 키 필요.

{
  "workflow": { "name": "...", "nodes": [...], "connections": {...} },
  "n8nUrl": "https://your-n8n.example.com",
  "n8nApiKey": "your-n8n-api-key"
}

응답 (200 OK):

{
  "success": true,
  "workflowId": "abc123",
  "workflowUrl": "https://your-n8n.example.com/workflow/abc123",
  "name": "Gmail AI 요약 to Slack"
}

---

대시보드 엔드포인트

사용자 분석 및 워크플로우 이력 데이터. JWT 필요.

GET /api/v1/dashboard

대시보드 개요 데이터 조회.

GET /api/v1/dashboard/history

워크플로우 생성 이력 조회 (페이지네이션 지원).

GET /api/v1/dashboard/history/:id

특정 워크플로우 생성 상세 조회.

GET /api/v1/dashboard/analytics

설정 가능한 기간의 사용량 분석 조회.

GET /api/v1/dashboard/subscription

현재 구독 정보 조회.

---

API 키 관리

서버 간 통합을 위한 API 키 관리. JWT 필요. Starter 이상 플랜 필요.

POST /api/v1/api-keys

새 API 키 생성.

GET /api/v1/api-keys

API 키 목록 조회 (키는 마스킹됨).

DELETE /api/v1/api-keys/:id

API 키 폐기.

---

오류 코드

상태	설명
400	잘못된 요청
401	인증 누락 또는 유효하지 않음
429	월간 사용량 초과
500	서버 내부 오류