이 문서는 Mori API 연동을 위해 필요한 인증 절차를 안내하는 가이드예요. 로그인 과정을 통해 액세스 토큰을 발급받고, 이후 필요한 API 요청 시 이를 자격 증명으로 사용할 수 있어요.
아래 다이어그램은 고객사가 Mori API에 접근하기 위해 따라야 할 인증 과정을 보여줍니다.
로그인이 완료되면, 필요에 따라 웹훅 엔드포인트를 등록할 수도 있어요.
단계 | 설명 | 유의 사항 |
---|---|---|
login(credentials) | 로그인 API를 호출하여 액세스 토큰을 발급받아요. | 토큰의 기본 유효 기간은 2시간이에요. |
**createWebhookEndpoint | ||
(accessToken, url)** | 로그인 후 발급된 토큰을 사용해 웹훅 엔드포인트를 등록할 수 있어요. | |
관련 내용은 웹훅 등록하기 문서에서 확인할 수 있어요. | 선택 사항이며, 이벤트 알림을 받고 싶을 때 설정하면 돼요. |
이 API는 고객사의 계정 정보로 로그인하여 액세스 토큰을 발급받는 데 사용돼요.
이 토큰은 이후 대부분의 API 요청 시 Authorization 헤더에 포함되어야 해요.
POST https://{{API_DOMAIN}}/api/v2/auth/login
필드 | 타입 | 설명 |
---|---|---|
string | Mori Biz에 등록된 고객사의 이메일 | |
password | string | 등록 시 설정한 비밀번호 |
키 | 설명 |
---|---|
accessToken | 이후 API 호출 시 사용할 인증 토큰 |
필드 | 타입 | 설명 |
---|---|---|
user.id | int | 고객사의 고유 ID |
user.email | string | 등록된 이메일 주소 |
user.apiKey | string | API 호출 시 사용할 API 키 |
user.migrationKey | string | 마이그레이션 용도로 사용되는 키 |
contract.planType | string | 현재 사용 중인 요금제 |
contract.planStartDate | string | 요금제 시작일 |
contract.planEndDate | string (nullable) | 요금제 종료일 (무료 플랜일 경우 null) |
contract.currentUsage | int | 현재 사용량 |
contract.usageLimit | int | 사용량 한도 |