REST API

Endpoints

리소스별 REST API 엔드포인트 전체 목록과 각 엔드포인트 문서의 구성 방식을 설명합니다.

엔드포인트 목록

Onttle REST API의 기본 주소는 다음과 같습니다.

https://api.onttle.com/v1

모든 요청에는 Authorization: Bearer {API_KEY} 헤더가 필요합니다. API Key는 Project 설정에서 발급합니다.

[이미지 영역] API 레퍼런스 사이드바 구조 (리소스별 그룹화된 엔드포인트 목록)


엔드포인트 문서 구성

각 엔드포인트 문서에는 다음 항목이 포함됩니다.

항목 설명
메서드와 경로 HTTP 메서드와 전체 경로
설명 엔드포인트가 수행하는 작업
권한 필요한 API Key 권한 또는 멤버 역할
Path 파라미터 경로에 포함된 가변 값
Query 파라미터 URL 쿼리 문자열로 전달하는 파라미터
요청 본문 POST, PUT, PATCH 요청의 JSON 필드
요청 예제 curl 및 TypeScript fetch 예제
성공 응답 HTTP 상태 코드와 JSON 응답 예시
오류 응답 발생 가능한 오류 코드

리소스 목록

Accounts

메서드 경로 설명
GET /accounts/me 현재 로그인한 계정 정보 조회
PUT /accounts/me 계정 정보 수정

Workspaces

메서드 경로 설명
GET /workspaces Workspace 목록 조회
POST /workspaces 새 Workspace 생성
GET /workspaces/{workspaceId} Workspace 상세 조회
PUT /workspaces/{workspaceId} Workspace 수정
DELETE /workspaces/{workspaceId} Workspace 삭제

Workspace Members

메서드 경로 설명
GET /workspaces/{workspaceId}/members Workspace 멤버 목록 조회
POST /workspaces/{workspaceId}/members 멤버 초대
PUT /workspaces/{workspaceId}/members/{memberId} 멤버 역할 수정
DELETE /workspaces/{workspaceId}/members/{memberId} 멤버 제거

Projects

메서드 경로 설명
GET /workspaces/{workspaceId}/projects Project 목록 조회
POST /workspaces/{workspaceId}/projects 새 Project 생성
GET /workspaces/{workspaceId}/projects/{projectId} Project 상세 조회
PUT /workspaces/{workspaceId}/projects/{projectId} Project 수정
DELETE /workspaces/{workspaceId}/projects/{projectId} Project 삭제

Project Members

메서드 경로 설명
GET /workspaces/{workspaceId}/projects/{projectId}/members Project 멤버 목록
POST /workspaces/{workspaceId}/projects/{projectId}/members 멤버 추가
PUT /workspaces/{workspaceId}/projects/{projectId}/members/{memberId} 멤버 역할 수정
DELETE /workspaces/{workspaceId}/projects/{projectId}/members/{memberId} 멤버 제거

Tables

메서드 경로 설명
GET /{projectId}/tables Table 목록 조회
POST /{projectId}/tables 새 Table 생성
GET /{projectId}/tables/{tableId} Table 상세 조회
PUT /{projectId}/tables/{tableId} Table 수정
DELETE /{projectId}/tables/{tableId} Table 삭제

Columns

메서드 경로 설명
GET /{projectId}/tables/{tableId}/columns Column 목록 조회
POST /{projectId}/tables/{tableId}/columns Column 추가
PUT /{projectId}/tables/{tableId}/columns/{columnId} Column 수정
DELETE /{projectId}/tables/{tableId}/columns/{columnId} Column 삭제

Contents

메서드 경로 설명
GET /{projectId}/tables/{tableId}/contents Contents 목록 조회
POST /{projectId}/tables/{tableId}/contents Contents 생성
GET /{projectId}/tables/{tableId}/contents/{contentsId} Contents 상세 조회
PUT /{projectId}/tables/{tableId}/contents/{contentsId} Contents 수정
DELETE /{projectId}/tables/{tableId}/contents/{contentsId} Contents 삭제

Categories & Variables

메서드 경로 설명
GET /{projectId}/categories Category 목록 조회
POST /{projectId}/categories Category 생성
GET /{projectId}/variables Variable 목록 조회
POST /{projectId}/variables Variable 생성

Translations

메서드 경로 설명
GET /{projectId}/translations 번역 목록 조회
POST /{projectId}/translations 번역 생성
PUT /{projectId}/translations/{translationId} 번역 수정
DELETE /{projectId}/translations/{translationId} 번역 삭제

Files

메서드 경로 설명
GET /{projectId}/files 파일 목록 조회
POST /{projectId}/files 파일 업로드
PUT /{projectId}/files/{fileId} 파일 교체
DELETE /{projectId}/files/{fileId} 파일 삭제

API Keys

메서드 경로 설명
GET /{projectId}/api-keys API Key 목록 조회
POST /{projectId}/api-keys API Key 생성
PUT /{projectId}/api-keys/{apiKeyId} API Key 수정
DELETE /{projectId}/api-keys/{apiKeyId} API Key 삭제

Webhooks

메서드 경로 설명
GET /{projectId}/webhooks Webhook 목록 조회
POST /{projectId}/webhooks Webhook 생성
PUT /{projectId}/webhooks/{webhookId} Webhook 수정
DELETE /{projectId}/webhooks/{webhookId} Webhook 삭제

Metrics & Logs

메서드 경로 설명
GET /workspaces/{workspaceId}/metrics 사용량 메트릭 조회
GET /{projectId}/logs API 요청 로그 조회

다음 단계

  • 인증 방식 — API Key 발급과 Bearer 인증 방법을 확인합니다.
  • 에러 코드 — HTTP 상태 코드별 오류 원인과 해결 방법을 확인합니다.
  • REST API 사용법 — 요청 예제와 응답 파싱 방법을 알아봅니다.