3Min API
메뉴 경로: 대시보드 > APIs > 새 API 만들기

새 엔드포인트 생성

개요

엔드포인트는 외부에서 JSON 데이터를 보낼 수 있는 주소(URL)입니다. 3Min API는 이 엔드포인트에 들어오는 데이터를 저장하고 로그를 남기며, 설정에 따라 웹훅으로 전달합니다.

이 페이지에서는 이름·설명·필수 필드(옵션) 만 입력하면 엔드포인트가 생성됩니다. 필수 필드는 나중에 상세 페이지에서도 언제든 수정할 수 있으니, 처음엔 건너뛰어도 됩니다.

생성 직후 상태

  • 자동으로 샌드박스 환경으로 생성됩니다
  • 샌드박스용 API 키(tm_test_ 접두사)가 즉시 발급됩니다
  • 프로덕션 API 키(tm_live_)는 발급되지만, 프로덕션 배포 전까지 프로덕션 호출은 거부되며 로그도 남지 않습니다
  • 공개 통합 가이드 페이지 링크가 자동 생성됩니다 (Swagger 스타일 테스트 + 코드 샘플)

진입 경로

  • 대시보드 우측 상단의 새 엔드포인트 버튼
  • 왼쪽 메뉴 APIs → 목록 페이지 우측 상단 새 API 만들기 버튼

기본 정보

기본 정보 입력

API 이름

필수 항목입니다.

  • 엔드포인트를 구분하기 위한 사용자용 이름입니다
  • 실제 API 경로(slug)는 시스템이 자동 생성하므로, 여기서는 데이터 성격을 잘 드러내는 이름을 쓰는 것이 좋아요
    • 좋은 예: contact-form, order-notification, wine-shop-sale
    • 피하면 좋은 예: test, api1, my endpoint
  • 제약:
    • 비워둘 수 없습니다
    • 같은 계정 내 중복 불가
    • 최대 길이 제한이 적용됩니다 (입력 시 초과하면 오류 메시지 표시)

설명

선택 항목입니다.

  • 엔드포인트의 목적을 적는 자유 텍스트입니다
  • 협업자나 미래의 자신을 위해 언제 이 엔드포인트가 호출되는지, 어떤 데이터를 받는지를 간단히 기록하세요
  • 예: "쇼핑몰 결제 완료 시 호출되는 주문 확정 알림"
  • 나중에 상세 페이지에서도 인라인 편집으로 수정 가능합니다

필수 필드

선택 항목입니다. 지금 설정하지 않아도 나중에 상세 페이지에서 추가할 수 있어요.

필수 필드 설정

API 호출 시 반드시 포함되어야 하는 JSON 필드를 미리 정의합니다. 여기서 정의한 필드가 요청에 누락되면 호출이 거부됩니다.

각 필드의 입력 항목

  • 필드 이름: 필드 키 (예: order_id, customer_email)
  • 데이터 타입: 문자열, 숫자, 불리언, 객체, 배열 중 선택
  • 검색 가능: 로그 페이지에서 검색 키워드로 사용할 수 있게 하려면 체크
  • 필드 설명 (선택): 협업자에게 전달할 설명

제약 사항

  • 검색 가능은 문자열 타입만 지정 가능
  • 검색 가능은 엔드포인트당 최대 2개까지만 지정 가능
  • 필드 이름은 문자 또는 언더스코어로 시작, 문자/숫자/언더스코어만 허용
  • 중복된 필드 이름은 허용되지 않습니다

검증 방식

해당 키가 JSON에 있는지만 확인합니다. 값의 내용이나 형식은 검사하지 않습니다.

지금 건너뛰어도 괜찮아요

필수 필드를 정해두지 않으면, 엔드포인트는 어떤 JSON 페이로드든 받아들입니다. 우선 엔드포인트를 만들고 샌드박스에서 테스트해 보면서 필요한 필드를 파악한 뒤, 엔드포인트 상세에서 추가해도 됩니다.

이 페이지에 없는 것

  • 웹훅 설정 — 생성 후 엔드포인트 상세 페이지에서 설정
  • 알림(Notification) 설정 — 마찬가지로 상세 페이지에서 설정
  • 협업키 발급 / 협업자 초대 — 상세 페이지의 협업키 관리에서 관리
  • 프로덕션 배포 — 상세 페이지의 Deploy to Production 버튼으로 수행

생성 후 흐름

API 만들기 버튼을 누르면 자동으로 엔드포인트 상세 페이지로 이동합니다. 거기서 다음을 이어가세요.

  1. Overview 카드에서 실제 Endpoint URL 확인
  2. Default API Key로 샌드박스 호출 테스트
  3. 필요하면 Webhook / Notifications / Collaboration Keys 설정
  4. 운영 준비가 되면 Deploy to Production으로 승격

자주 막히는 부분

  • 이름을 나중에 바꿀 수 있나요? — 네, 상세 페이지 Overview에서 설명 포함 언제든 수정할 수 있어요
  • 엔드포인트를 여러 개 만들어야 하나요? — 대부분의 경우 아니요. 3Min API는 문서 저장 방식이라 하나의 엔드포인트에 중첩 JSON 한 덩어리로 보내면 됩니다. 업무 이벤트가 근본적으로 다를 때만(예: 주문 vs 문의) 엔드포인트를 나누세요
  • 필수 필드를 까다롭게 정하면 좋을까요? — 처음에는 비워두고, 협업자와 실제로 테스트해 본 뒤 "항상 들어와야 하는" 필드만 추가하는 편이 유연해요
이전
대시보드
다음
엔드포인트 상세