본문으로 건너뛰기
⌘ K
English한국어

메타

서비스 상태와 내 키 정보를 확인하세요.

어떤 연동이든 처음에는 두 가지를 묻습니다. API가 동작하는지, 그리고 이 키로 무엇을 할 수 있는지입니다. 이 두 엔드포인트가 그 질문에 답합니다. 다른 것을 디버깅하기 전에 먼저 호출해 보세요. “이 호출은 왜 403일까”에 대한 답은 거의 항상 /me에 있습니다.

GET/ping인증 없음

키가 필요 없습니다. API에 접속할 수 있는지 확인하고 현재 제공하는 버전을 알려 주므로, 모니터링의 상태 확인(헬스 체크)으로 쓸 수 있습니다.

요청
curl https://tahoe.workonward.com/api/partner/v1/ping
응답
{
  "object": "ping",
  "ok": true,
  "api_version": "2026-09-09"
}

GET/me유효한 키라면 모두

스코프와 상관없이 유효한 키라면 모두 호출할 수 있습니다. 보낸 키에 대해 알려 줍니다. 무엇을 읽을 수 있는지, 어떤 워크스페이스에 접근하는지, 요청할 때마다 워크스페이스를 지정해야 하는지, 오늘의 한도와 사용량을 확인할 수 있습니다.

요청
curl https://tahoe.workonward.com/api/partner/v1/me \
  -H "Authorization: Bearer $TAHOE_API_KEY"
응답
{
  "object": "credential",
  "id": "pk_9tRc4mQx7Lb2",
  "name": "Acme HRIS sync",
  "environment": "live",
  "scopes": ["applications:read", "contact:read", "jobs:read", "workspaces:read"],
  "scope_descriptions": {
    "applications:read": "Applications, their stage and status, and match scores.",
    "contact:read": "Work and personal email addresses your workspace has already revealed.",
    "jobs:read": "Job postings, their content, application forms and pipeline stages.",
    "workspaces:read": "Workspace name and creation date."
  },
  "workspace_scope": "list",
  "workspace_ids": ["wsp_4Kd8sPm2Qx7L"],
  "workspace_id_required": false,
  "rate_limits": {
    "general_per_minute": 600,
    "expensive_per_minute": 60,
    "download_per_minute": 30,
    "personal_data_reads_per_day": 5000,
    "personal_data_reads_used_today": 128,
    "max_page_size": 100,
    "max_result_window": 10000
  },
  "created_at": "2026-09-09T10:14:22.510Z",
  "expires_at": "2026-12-08T10:14:22.510Z",
  "api_version": "2026-09-09"
}
필드의미
id키 핸들입니다. 로그에 남겨도 안전하며, 문의할 때 알려 주실 ID입니다.
name키를 만들 때 붙인 이름입니다.
environmentlive 또는 test입니다. 둘 다 같은 데이터를 읽으며, 접두사는 로그에서 둘을 구분하는 용도일 뿐입니다.
scopes키가 읽고 바꿀 수 있는 정확한 범위입니다.
scope_descriptions스코프마다 붙은 한 줄 설명입니다.
workspace_scopelist: 키가 workspace_ids에 있는 워크스페이스에 접근합니다. all: 여러 워크스페이스에 걸친 교차 워크스페이스 키입니다.
workspace_idslist 키가 접근할 수 있는 워크스페이스 핸들입니다.
workspace_id_required교차 워크스페이스 키라면 true입니다. 이때는 모든 요청에 ?workspace_id=wsp_...를 넣어야 하며, 없으면 400 workspace_id_required로 실패합니다. 둘 이상의 워크스페이스에 접근하는 list 키도 이 값을 넣어야 합니다.
rate_limits분당 요청 한도, 일일 개인 데이터 한도와 오늘 사용한 양, 최대 페이지 크기, 페이지를 넘길 수 있는 최대 깊이입니다. 요청 한도와 할당량
expires_at키가 만료되는 시점입니다. 만료되지 않는 키라면 null입니다.
api_versionTahoe-Api-Version 헤더에 담기는 것과 같은 날짜입니다.

OpenAPI 문서

기계가 읽을 수 있는 OpenAPI 문서를 기본 URL 아래에서 제공합니다. 사람이 직접 쓴 문서가 아니라 실행 중인 서비스에서 생성되므로, 파라미터 이름이나 응답 형태가 이 문서와 다르다면 OpenAPI 문서가 맞습니다.

요청
curl https://tahoe.workonward.com/api/partner/v1/openapi.json -o tahoe-openapi.json

관련 문서