API 개방형 플랫폼 개요

Braidrun 워크플로 개방형 플랫폼을 사용하면 외부 시스템이 안정적인 REST API를 통해 워크플로를 구동할 수 있습니다. 즉, 실행 트리거, 결과 읽기, 승인 결정 푸시, 제품 다운로드 등이 가능합니다. 모든 공개 인터페이스는 API 키로 인증됩니다. 동일한 메커니즘이 웹후크, 승인 콜백 및 개방형 플랫폼 v1 엔드포인트를 포괄합니다.

누가 사용해야 하는가

• CI/CD, 내부 비즈니스 시스템, 모바일 앱 서비스에서 워크플로를 트리거해야 하는 개발자
• Slack/Telegram/email의 링크를 클릭하여 승인을 완료하는 운영 시나리오
• 파트너에게 Workflow-as-a-Service를 제공하는 팀
• 실행 결과를 다시 엔터프라이즈 데이터 웨어하우스/BI 시스템으로 전달해야 하는 데이터 팀

전체 아키텍처

┌──────────────────┐    Authorization: Bearer dyk_xxx     ┌──────────────────────┐
│   你的客户端     │ ───────────────────────────────────▶ │  Braidrun Workflow    │
│                  │                                       │   开放平台 v1 / Webhook │
│  - SDK / curl    │ ◀─── 200 OK + JSON ──────────────── │                      │
│  - CI/CD         │ ◀─── 429 + Retry-After ──────────── │  - 校验 scope        │
│  - 邮件链接      │ ◀─── 401 Unauthorized ───────────── │  - 速率限制          │
└──────────────────┘                                       │  - 累计用量          │
                                                            └──────────────────────┘

완전한 개방형 플랫폼 호출: 클라이언트는 dyk_<id>_<secret> 형식의 토큰을 보유하고 각 요청마다 Bearer Header를 전달합니다. 서버는 범위를 확인한 후 자동으로 사용량을 누적합니다. 패키지 속도 상한을 초과하면 HTTP 429 + Retry-After가 반환됩니다.

5분 안에 시작하세요

1. 로그인 Braidrun 콘솔 → "계정 설정 → API 키" 입력
2. API 키 생성 "새 API 키" 클릭 → 필요한 범위 선택(WORKFLOW_READ + WORKFLOW_EXECUTE를 먼저 선택하는 것이 좋습니다) → 유효 기간 설정
3. 토큰 복사 성공적으로 생성되면 토큰이 일회성으로 표시됩니다. 즉시 복사하여 키 관리 도구에 저장하세요.
4. 엔드포인트 테스트 호출 컬을 사용하여 자신만의 워크플로 목록을 가져옵니다.

curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

개방형 범위

가이드와 상담하세요

• 공식 SDK · 12개 언어를 지원하는 타입 안전 API 클라이언트
• API 키 관리 · 생성/범위/해지/사용 분석
• 인증 및 속도 제한 · 헤더/패키지 속도/오류 코드를 작성하는 세 가지 방법
• 웹훅 엔드포인트 · 워크플로 트리거 + 승인 콜백
• v1 엔드포인트 참조 · 전체 14개 v1 엔드포인트