알마니 Open API

알마니 Open API는 알림톡 템플릿 운영을 코드로 자동화할 수 있는 REST API입니다. 템플릿 등록부터 심사 요청, 승인 상태 확인까지 운영 화면을 거치지 않고 고객사 시스템에서 직접 처리할 수 있습니다.

모든 요청과 응답은 HTTPS 위에서 JSON으로 주고받으며, 기준 주소는 https://docs.almani-center.com/open/v1 입니다. 사이트, 템플릿, 발신프로필, 계정 리소스를 제공합니다.

문서 구성 왼쪽 사이드바의 공통 규약에서 인증·요청/응답 규격·에러 형식을 먼저 확인한 뒤, 리소스별 레퍼런스로 이동하는 순서를 권장합니다.

핵심 가치 — 신청부터 상태 확인까지 자동화

알림톡 템플릿은 카카오 심사를 통과해야 발송에 사용할 수 있습니다. 알마니 Open API는 이 흐름 전체를 API 호출로 연결합니다.

템플릿 신청 — 템플릿 신청 API로 템플릿을 등록합니다. 기본값(autoReview: true)으로는 등록 즉시 카카오 검수까지 요청되어 상태가 REQ 가 됩니다. autoReview: false 로 등록한 경우에만 REG 초안으로 저장됩니다.
재검수 요청 — 반려되거나 초안으로 저장된 템플릿은 재검수 요청 API로 검수를 다시 요청해 REQ 상태로 만듭니다.
상태 확인 — 템플릿 조회 API로 승인 APR · 반려 REJ · 수정 UPT 상태를 확인합니다. 승인된 템플릿만 발송에 사용할 수 있습니다.

심사 반려를 줄이려면 광고성 문구가 포함된 템플릿은 카카오 심사에서 반려될 수 있습니다. 템플릿 심사 가이드에서 작성 기준을 먼저 확인하세요.

인증 개요

모든 API 요청에는 두 개의 헤더가 필요합니다. 발급받은 API 키를 Authorization 헤더에 Bearer 방식으로 담고, 대상 사이트를 X-Site-Id 헤더로 지정합니다. 단, GET /sites 와 GET /me 는 X-Site-Id 헤더를 생략할 수 있습니다.

Authorization: Bearer ak_live_xxxx
X-Site-Id: 1024

문서의 ak_live_xxxx 는 더미 키입니다. 키 발급 방법과 상세 규칙은 공통 규약 — 인증을, 응답마다 함께 내려오는 처리율 제한 정보(meta.quota)는 공통 규약 — 처리율 제한을 참고하세요.

키 보안 API 키는 계정의 모든 권한을 대표합니다. 브라우저 코드나 공개 저장소에 노출하지 말고, 서버 측 환경 변수로만 관리하세요.

문서 둘러보기

빠른 시작 키 준비부터 첫 템플릿 등록까지 단계별로 따라 합니다. 템플릿 심사 가이드 카카오 심사 기준과 반려를 줄이는 작성 요령을 안내합니다. 템플릿 API 레퍼런스 템플릿 신청·조회·목록·재검수·검수 취소·검수 이력·사전 검증 엔드포인트 상세입니다.

5줄로 시작하기

아래 cURL 한 번이면 첫 템플릿이 등록되고 카카오 검수까지 바로 요청됩니다(기본 autoReview: true). 더미 키 ak_live_xxxx 를 발급받은 키로 바꿔 실행하세요.

          첫 템플릿 등록 — cURL
        

curl -X POST "https://docs.almani-center.com/open/v1/templates" \
  -H "Authorization: Bearer ak_live_xxxx" \
  -H "X-Site-Id: 1024" \
  -H "Content-Type: application/json" \
  -d '{"templateName": "주문 완료 안내", "templateType": "BA", "category": "004001", "content": "#{고객명}님, 주문이 정상적으로 접수되었습니다."}'
        

다음 단계는 빠른 시작 가이드에서 검수 상태 확인까지 이어서 진행합니다.