Walla Open API 문서

Walla Open API를 사용하면 폼 관리, 워크스페이스 조회, 폼 발송, 응답 수집 등을 프로그래밍 방식으로 처리할 수 있습니다.

개요

Walla Open API는 RESTful 방식으로 동작하며, 아래 기능을 제공합니다.

워크스페이스 관리: 워크스페이스 정보를 조회합니다
폼 관리: 폼 데이터와 설정을 조회합니다
폼 발송: 이메일 또는 SMS로 폼을 발송합니다
응답 추적: 폼 응답과 제출 데이터를 조회하고 모니터링합니다

리소스 계층 구조

Walla API의 리소스는 아래와 같은 계층 구조로 구성됩니다.

Team → Workspace → Form → Response

Team(팀): 최상위 조직 단위입니다. API 키는 팀 단위로 생성되며, 팀 정보가 자동으로 포함됩니다.
Workspace(워크스페이스): 팀 안에서 폼과 프로젝트를 묶는 단위입니다.
Form(폼): 워크스페이스 안에서 만든 설문이나 폼입니다.
Response(응답): 폼에 제출된 개별 응답입니다.

참고: API 키에 팀 정보가 포함되어 있으므로, API 요청 시 별도로 팀 정보를 전달할 필요가 없습니다.

기본 URL

모든 API 요청의 기본 URL은 다음과 같습니다.

https://api.walla.my/open-api/v1

시작하기

인증

빠른 시작 가이드

API 레퍼런스

에러 코드

주요 기능

워크스페이스 관리

접근 가능한 모든 워크스페이스 목록을 조회하고, 개별 워크스페이스의 상세 정보를 확인할 수 있습니다.

폼 관리

폼 목록, 설정, 제출 수 등 폼 관련 데이터를 조회할 수 있습니다.

폼 발송

이메일이나 SMS로 여러 수신자에게 폼을 발송하고, 발송 상태와 참여도를 추적할 수 있습니다.

응답 수집

페이지네이션을 지원하는 응답 조회 API로, 고객 키와 제출 시간 등 상세 데이터를 확인할 수 있습니다.

API 사양

버전: 1.0
프로토콜: HTTPS
데이터 형식: JSON
인증: API 키 (헤더를 통한 인증)

지원

문의 사항이나 기능 요청이 있으면 Walla 지원팀에 연락해 주세요.

API 엔드포인트 개요

카테고리	엔드포인트	설명
워크스페이스	`GET /workspaces`	모든 워크스페이스 조회
워크스페이스	`GET /workspaces/{workspaceId}`	특정 워크스페이스 조회
워크스페이스	`GET /workspaces/{workspaceId}/forms`	워크스페이스 내 폼 목록 조회
폼	`GET /forms`	모든 폼 조회
폼	`GET /forms/{formId}`	특정 폼 조회
필드	`GET /field-output-schemas`	필드 출력 스키마 조회
필드	`GET /forms/{formId}/fields`	폼 필드 목록 조회
필드	`GET /forms/{formId}/fields/{fieldId}`	특정 필드 상세 정보 조회
필드	`GET /forms/{formId}/fields/{fieldId}/description`	필드 설명 조회
발송	`POST /forms/{formId}/delivery`	폼 발송
발송	`GET /forms/{formId}/delivery`	발송 수신자 목록 조회
발송	`POST /forms/{formId}/delivery/status`	발송 상태 조회
응답	`GET /forms/{formId}/responses`	폼 응답 목록 조회 (페이지네이션)
응답	`GET /forms/{formId}/responses/{responseId}`	특정 응답 조회

다음 단계

각 API 문서를 살펴보고, Walla Open API로 원하는 기능을 구현해 보세요.

소개