Postman Collection으로 빠르게 시작하기

Postman은 실제 데이터로 API 요청을 모델링하여 원하는 프로그래밍 언어로 솔루션을 개발하기 전에 테스트할 수 있는 도구입니다. 최상의 경험과 호환성을 위해 최신 네이티브 버전 사용을 권장합니다.

즉시 API 테스트 시작하기

모두싸인 Postman Collection 열기

인증 설정

이 컬렉션은 API Key 인증을 사용합니다. 모두싸인 API는 Basic HTTP 인증 스킴을 사용하며, 사용자 이메일과 발급받은 API Key를 조합하여 인증합니다.

Postman에서 설정하기

컬렉션의 Authorization 탭에서 타입을 Basic Auth로 선택합니다.
Username에 {{email}}, Password에 {{api_key}}를 입력합니다.
요청 URL에는 {{base_url}} 환경 변수를 사용합니다.

Postman이 이메일과 API Key를 Base64로 인코딩하여 Authorization: Basic 헤더를 자동으로 생성합니다. 인코딩된 인증 값을 문서나 소스 코드에 직접 저장하지 마세요.

cURL 예시

MODUSIGN_EMAIL="YOUR_EMAIL"
MODUSIGN_API_KEY="YOUR_API_KEY"

curl --request GET \
  --url 'https://api.modusign.co.kr/documents?offset=0&limit=10' \
  --header 'Accept: application/json' \
  --user "${MODUSIGN_EMAIL}:${MODUSIGN_API_KEY}"

--user 옵션을 사용하면 cURL이 이메일과 API Key를 Base64로 인코딩해 Basic 인증 헤더를 생성합니다.

Postman 활용 가이드

컬렉션 효율적으로 구성하기

폴더별 구성: 관련 엔드포인트를 폴더로 그룹화합니다.
환경 변수: 개발, 스테이징, 프로덕션 환경의 값을 분리합니다.
컬렉션 수준 인증: Basic Auth 설정을 컬렉션에 적용하여 각 요청에서 재사용합니다.

자세한 내용은 Postman 컬렉션 공식 가이드를 참조하세요.

환경 변수 설정하기

컬렉션을 더 효율적으로 사용하려면 다음 값을 Postman 환경 변수로 설정하세요.

{
  "base_url": "https://api.modusign.co.kr",
  "email": "YOUR_EMAIL",
  "api_key": "YOUR_API_KEY"
}

환경 변수를 사용하면 환경별 설정을 쉽게 전환할 수 있습니다. 공유하거나 내보내기 전에 민감한 값이 포함되어 있지 않은지 확인하세요.

다음 단계

API 참조 문서: 모든 엔드포인트의 요청 및 응답 스키마와 에러 코드를 확인합니다.
API Key로 요청하기: Basic HTTP 인증을 통한 API Key 사용법을 단계별로 확인합니다.

문의사항이 있으시면 모두싸인 고객센터를 통해 문의해 주세요. API 연동 관련 기술 지원을 받을 수 있습니다.