Yave System

API · 개발자

붙이는 사람을 위한 화면 24종 — API 키 만들기와 가려 두기와 갈아 끼우기 · 웹훅 등록과 전송 기록과 재시도 · 엔드포인트 문서와 언어별 예시와 바로 보내 보기 · 호출량과 한도와 오류 코드.

구조 24개 · 전체 1,068개 중

목록에는 구조만 있습니다. 색은 각 액자의 견본을 눌러 바꾸고, 체크하면 그때 고른 색이 함께 저장됩니다.

예: 슬라이더, 폼, 2단, split-phone

API 키

6개 구조

발급된 키 목록

좌측 정렬 · 보통 · 넓은 폭

API 키

키는 만들 때 한 번만 보입니다.

이름 키 환경 마지막 사용 작업
운영 서버 sk_live_••••••••••••4f2a production 3분 전
개발 환경 sk_test_••••••••••••9c71 development 어제
배포 파이프라인 sk_live_••••••••••••0b38 production 지난주

키 만들기 — 이름과 환경

좌측 정렬 · 보통 · 본문 폭

키 만들기

어디에 쓰는 키인지 적어 두면 나중에 지울 때 헷갈리지 않습니다.

만료를 두면 잊고 방치되는 키가 줄어듭니다.

한 번만 보이는 키

좌측 정렬 · 보통 · 본문 폭

이 키는 지금만 보입니다

창을 닫으면 다시 볼 수 없습니다. 안전한 곳에 옮겨 두시고, 잃어버리면 새로 만들어야 합니다.

sk_live_••••••••••••••••••••••••4f2a

이 키가 할 수 있는 일 고르기

좌측 정렬 · 보통 · 본문 폭

이 키가 할 수 있는 일

필요한 것만 켜세요. 나중에 줄이면 쓰던 곳이 멈춥니다.

갈아 끼우기 — 겹치는 기간

좌측 정렬 · 보통 · 본문 폭

키 갈아 끼우기

새 키를 만들고, 옛 키는 정한 기간 동안 같이 살려 둡니다. 그 사이에 쓰던 곳을 옮기면 멈추지 않습니다.

  1. 1 새 키를 만듭니다 지금 바로 쓸 수 있습니다.
  2. 2 쓰던 곳을 새 키로 바꿉니다 배포 · CI · 서버 환경변수.
  3. 3 옛 키를 닫습니다 겹치는 기간이 끝나면 자동으로 닫힙니다.

아직 키가 없을 때

좌측 정렬 · 보통 · 본문 폭

아직 키가 없습니다

키를 만들면 바깥에서 이 조직의 데이터를 읽고 쓸 수 있습니다.

웹훅

6개 구조

등록된 웹훅 목록

좌측 정렬 · 보통 · 넓은 폭

웹훅

/hooks/project project.created 마지막 200 2분 전
/hooks/member member.invited 마지막 200 1시간 전
/hooks/billing payment.failed 마지막 500 어제

웹훅 만들기 — 주소와 이벤트

좌측 정렬 · 보통 · 본문 폭

웹훅 만들기

고른 일이 생기면 이 주소로 POST 를 보냅니다.

https 만 됩니다. 2초 안에 2xx 를 주셔야 성공으로 봅니다.

보낼 이벤트

전송 기록 — 성공과 실패

좌측 정렬 · 보통 · 넓은 폭

전송 기록

이벤트 주소 응답 시각 작업
project.created /hooks/project 200 2분 전
member.invited /hooks/member 200 1시간 전
payment.failed /hooks/billing 500 어제
project.created /hooks/project 200 2분 전
member.invited /hooks/member 200 1시간 전

보낸 것 들여다보기

좌측 정렬 · 보통 · 본문 폭

보낸 것

200 2분 전 · 118ms
POST /hooks/project
{
  "data": [
    { "id": "proj_…", "name": "디자인 시스템", "status": "open" }
  ],
  "next_cursor": null
}

실패한 것 다시 보내기

좌측 정렬 · 보통 · 넓은 폭

실패한 전송

이벤트 주소 응답 시각 작업
project.created /hooks/project 500 2분 전
member.invited /hooks/member 500 1시간 전
payment.failed /hooks/billing 500 어제

실패하면 스스로 다섯 번까지 다시 보냅니다(1분 · 5분 · 30분 · 2시간 · 6시간). 그 뒤에는 여기서 직접 눌러 주세요.

서명 비밀 — 검증하는 법

좌측 정렬 · 보통 · 본문 폭

서명 비밀

보내는 요청마다 X-Signature 머리를 붙입니다. 이 비밀로 다시 계산해 같은 값이 나오는지 보시면, 저희가 보낸 것이 맞는지 알 수 있습니다.

whsec_••••••••••••••••7b1e

새로 만들면 옛 비밀로 검증하던 곳이 바로 실패합니다.

문서 · 예시

6개 구조

엔드포인트 한 장

좌측 정렬 · 보통 · 넓은 폭

GET /v1/projects

프로젝트 목록 읽기

이 조직의 프로젝트를 최근에 바뀐 순서로 돌려 줍니다. 한 번에 최대 100개이고, 나머지는 커서로 이어 받습니다.

요청

import { Example } from "@example/sdk";

const client = new Example({ apiKey: process.env.API_KEY });
const { data } = await client.projects.list({ limit: 20 });

응답 200

{
  "data": [
    { "id": "proj_…", "name": "디자인 시스템", "status": "open" }
  ],
  "next_cursor": null
}

언어별 예시 탭

좌측 정렬 · 보통 · 본문 폭

curlNodePython
curl https://api.example.dev/v1/projects \
  -H "Authorization: Bearer <발급받은 키>" \
  -H "Content-Type: application/json"

좌 요청 · 우 응답

좌측 정렬 · 보통 · 넓은 폭

요청

curl https://api.example.dev/v1/projects \
  -H "Authorization: Bearer <발급받은 키>" \
  -H "Content-Type: application/json"

응답

{
  "data": [
    { "id": "proj_…", "name": "디자인 시스템", "status": "open" }
  ],
  "next_cursor": null
}

파라미터 표 — 이름 · 타입 · 필수

좌측 정렬 · 보통 · 넓은 폭

파라미터

이름 타입 필수 설명
limit integer 선택 한 번에 받을 개수. 기본 20, 최대 100.
cursor string 선택 이전 응답의 next_cursor 를 그대로 넘깁니다.
project_id string 필수 어느 프로젝트인지.
status enum 선택 open · closed · all 중 하나.
since date 선택 이 시각 뒤에 바뀐 것만.

여기서 바로 보내 보기

좌측 정렬 · 보통 · 넓은 폭

GET /v1/projects

개발(test) 환경으로만 보냅니다.

200 42ms
{
  "data": [
    { "id": "proj_…", "name": "디자인 시스템", "status": "open" }
  ],
  "next_cursor": null
}

라이브러리 설치 안내

좌측 정렬 · 보통 · 본문 폭

라이브러리로 쓰기

npmpnpmyarn
npm i @example/sdk

Node 18 이상. 타입 정의가 함께 들어 있습니다.

상태 · 한도

6개 구조

호출량 — 시간대별

좌측 정렬 · 보통 · 넓은 폭

호출량

182K / 200K — 이번 달

0 2 4 6 8 10 12 14 16 18 20 22

가로는 시각(2시간 단위), 세로는 요청 수입니다.

한도와 남은 만큼

좌측 정렬 · 보통 · 본문 폭

한도

분당 요청 수로 셉니다. 넘으면 429 와 함께 Retry-After 를 보냅니다.

분당 한도
600 요청
지금 이번 분
412 요청
남은 만큼
188 요청
다시 차는 때
38초 뒤

한도의 69%

오류 코드 표

좌측 정렬 · 보통 · 넓은 폭

오류 코드

코드 이름 무슨 뜻인가
400 invalid_request 빠진 값이 있거나 형식이 다릅니다.
401 unauthorized 키가 없거나 틀렸습니다.
403 forbidden 이 키에 그 권한이 없습니다.
429 rate_limited 한도를 넘었습니다. Retry-After 를 보세요.
500 server_error 저희 쪽 문제입니다. 그대로 다시 보내도 됩니다.

요청 기록 — 상태 코드와 걸린 시간

좌측 정렬 · 보통 · 넓은 폭

요청 기록

메서드 경로 상태 걸린 시간 시각
GET /v1/projects 200 42ms 3분 전
POST /v1/projects 201 118ms 5분 전
GET /v1/members 200 36ms 12분 전
POST /v1/invites 422 51ms 1시간 전
GET /v1/usage 429 8ms 2시간 전
DELETE /v1/keys/… 204 29ms 어제

지금 잘 돌고 있나

좌측 정렬 · 보통 · 본문 폭

지금 상태

대체로 정상
API 정상
웹훅 전송 정상
대시보드 정상
일괄 내보내기 느림

버전과 지원 종료 예고

좌측 정렬 · 보통 · 본문 폭

2026-03-01 지금 쓰는 판 기본으로 적용됩니다.
2025-09-01 아직 됩니다 2027년 3월까지 지원합니다.
2025-01-01 곧 끝납니다 올해 말에 닫힙니다. 옮겨 주세요.

0개 선택됨

이어 보기