connections
POST /v1/connections/{provider}
Validate or store a provider access token.
인증
Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 connections.manage 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.
조직 ID가 들어가는 위치
이 엔드포인트는 org_id을(를) 쿼리 매개변수로 사용합니다. 생략하면 테넌트 하위 트리 전체가 호출 대상이 되며, 값을 전달하면 특정 조직으로 호출 범위를 좁힐 수 있습니다.
조직 ID는 대시보드의 API 키 화면에서 키 바로 옆에 있습니다. 이는 실행하는 모든 호출에서 동일한 ID입니다.
무료 체험하기
대괄호 안에 있는 모든 내용을 사용자 지정 값으로 바꾸고, 키 플레이스홀더는 대시보드의 키로 바꾸세요.
curl -X POST https://api.zinndigital.com/v1/connections/{provider} \
-H "Authorization: Bearer zdk_live_…"로그인하셨나요? 대시보드의 API 콘솔이 실제 조직 ID와 본인의 키를 자동으로 채우고 라이브 API를 대상으로 요청을 실행하므로 실제 응답을 확인할 수 있습니다. API 콘솔에서 이 엔드포인트를 여세요
상세 정보
With validate_only the token is checked and nothing is stored, and the result is returned with 200 even when the token is invalid — an invalid token is an answer the caller renders, not a request error. Without it the token is re-validated and then stored in Vault, returning 201; a token that fails validation is rejected with TOKEN_INVALID and never persisted. The token itself is never logged or echoed. Requires connections.manage.
매개변수
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
provider (path) | ConnectionProvider | 예 | The third-party provider whose connections are addressed. |
org_id (query) | Uuid | 아니요 | Which organization this connected account belongs to. Required when the caller manages connections for more than one — a reseller or an agency by construction — because a… |
Idempotency-Key (header) | string | 아니요 | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
응답
| 이름 | 유형 | 필수 | 설명 |
|---|---|---|---|
valid | boolean | 예 | — |
account_login | object | 예 | The account the token authenticates as, when valid. |
scopes | string[] | 예 | — |
missing_scopes | string[] | 예 | Required scopes the token lacks. Empty when the token is valid, and also empty when the provider could not enumerate its permissions — in that case the connection is usable but… |
message | object | 예 | Human-readable explanation, or null when valid. |
permissions | PermissionReport | null | 아니요 | The per-permission checklist, exercised against the provider. ⛔ null means we cannot test this provider's permissions — it does not mean "nothing is required". The two… |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 422 · 429 · 503