시작하기
이 튜토리얼에서는 온프레미스 API 클라이언트를 설정하고, 비즈니스 전화번호를 등록하고, 설정을 업데이트하고, 테스트 메시지를 보내는 방법을 설명합니다.
이 API를 시작하는 과정은 세 부분으로 나눌 수 있습니다.
- 자산 준비 — 시작하기 전에 WhatsApp Business 계정을 포함하여 API 통합을 완료하는 데 필요한 자산을 설정해야 합니다.
- 온프레미스 API 클라이언트 설치 — API 클라이언트를 설치합니다. 클라이언트가 작동하면 앱 설정을 업데이트할 수 있습니다.
- 클라이언트 사용 시작 —
/account로 API 호출을 보내서 전화번호를 등록하고/messages로 호출을 보내서 테스트 메시지를 전송합니다.
시작하기 전에
다음 항목이 필요합니다.
- WhatsApp Business 계정에 대한 크레딧 라인 — 청구 프로세스에 대한 자세한 정보는 온프레미스 API 청구 정보를 참조하세요.
- 터미널과 같은 명령줄 도구 또는 cURL 요청을 실행할 수 있는 Postman 등의 앱
비즈니스를 인증한 다음에는 비즈니스가 WhatsApp 서비스 약관과 WhatsApp 커머스 정책을 준수하는지 검토를 받게 됩니다. 이 단계는 자동으로 시작됩니다. 비즈니스 관리자에서 WhatsApp Business 계정의 설정 탭에서 비즈니스 인증 및 비즈니스 검토 상태를 확인할 수 있습니다. 승인되면 비즈니스 인증 상태가 인증됨으로 표시되고 계정 상태가 승인됨으로 표시됩니다.
WhatsApp 계정 설정하기
전화번호와 표시 이름을 WhatsApp Business 계정에 추가합니다. 검토를 위해 표시 이름이 제출됩니다.
표시 이름을 바꾸고 싶다면 등록을 완료하기 전까지 얼마든지 변경할 수 있습니다. 등록 후에는 표시 이름을 한 번 변경하면 30일 이후에 다시 변경할 수 있습니다.
모든 검토가 완료되면 온프레미스 API 클라이언트 등록 시 필요한 base64 인코딩 인증서를 확인하고 이에 액세스할 수 있습니다. 통합을 시작할 때 승인된 표시 이름을 등록한 다음, 표시 이름을 추가로 변경하는 것이 좋습니다. 통합 후에는 언제든 표시 이름을 변경할 수 있습니다.
청구 및 가격 정보 검토
비즈니스에서 온프레미스 API를 통해 메시지를 보내기 시작할 때는 비용이 언제 어떤 방식으로 청구되는지 파악하고 월간 인보이스로 비용을 지불하고 내역을 확인하는 등의 청구 절차를 이해하는 것이 중요합니다. 자세한 내용은 WhatsApp Business 계정 청구 정보를 참조하세요. 가격 책정 규칙과 메시지당 비용은 가격 페이지를 참조하세요.
권장 소프트웨어 버전
| 소프트웨어 | 버전 | 상세 정보 |
|---|---|---|
온프레미스 API | ||
AWS용 온프레미스 API | 템플릿 버전: | |
MySQL |
| MySQL 8로 마이그레이션한 데이터베이스는 MySQL 5로 다운그레이드할 수 없습니다. 그러므로 마이그레이션하기 전에 데이터베이스 백업을 만드세요. |
PostgreSQL |
|
|
Docker |
|
statx syscall이 허용 리스트에 등록된 Docker용 syscall에 있는지 확인하세요. |
Postman | 모든 최신 버전 | |
libseccomp |
|
|
glibc |
|
|
운영 체제(OS) | 최신 버전 | 커널 버전 |
1단계: 온프레미스 API 클라이언트 설치
환경
기본적으로 온프레미스 API 클라이언트는 Docker를 기반으로 합니다. 각 구성 요소에 대한 내용은 클라이언트 아키텍처를 참조하세요.
현재 온프레미스 API 클라이언트는 Windows용 Docker 또는 Linux용 Windows Subsystem을 지원하지 않습니다. 개발에 필요한 경우 Linux Virtual 기기를 사용하여 Docker를 실행하는 것이 좋습니다. 프로덕션 작업 부하의 경우 Linux Server를 사용하여 호환성 및 성능 문제가 발생하지 않도록 하는 것이 좋습니다.
장비
온프레미스 API 클라이언트는 Linux용 Docker를 실행할 수 있고 인터넷이 연결된 모든 머신(가상 머신 또는 Linux 서버)에서 실행됩니다. 자세한 내용은 FAQ를 참조하세요. 예를 들어 간단한 테스트는 노트북에서 진행할 수 있습니다. 프로덕션 환경 서버의 경우에는 250GB SSD, 16GB RAM, 4코어 CPU 이상의 사양을 권장합니다. HDD는 부하 시에 I/O 속도로 인한 병목 현상이 발생하므로 권장하지 않습니다.
대부분의 경우 Coreapp과 Webapp 컨테이너에서 별도의 물리적 서버에 데이터베이스를 실행해야 합니다. 데이터베이스 서버는 컴퓨터에서 지연이 몇 밀리초 이내로만 발생해야 합니다.
설치
온프레미스 API를 시작하는 방법은 두 가지입니다.
- Amazon Web Services(AWS): AWS를 사용하거나 보다 독립적인 솔루션을 원한다면 AWS 가이드를 참조하세요. AWS 솔루션은 사용자가 관리하고 소유하는 AWS 클라우드에 백업, 복구 등을 포함한 전체 온프레미스 API 솔루션을 설정합니다.
온프레미스 API 클라이언트가 실행되면 admin으로 로그인하여 나머지 설정 단계를 실행해야 합니다.
설정 업데이트
온프레미스 API 클라이언트가 작동하면 앱 설정을 변경할 수 있습니다. 하지만 등록이 완료되기 전까지는 온프레미스 API 클라이언트의 여러 가지 프로필 설정에 액세스할 수 없습니다.
- 앱 설정은 클라이언트 작동 방법(예: 콜백 설정, Webhooks, 온콜 페이저, 발송된 상태, 미디어 다운로드 동작 등)과 관련이 있습니다. 참고: 수신 메시지 또는 오류에 대한 알림을 수신하려면 Webhooks URL을 설정할 것을 강력히 권장합니다.
- 비즈니스 프로필 설정과 프로필 설정은 비즈니스 정보(예: 주소, 이메일, 웹사이트, 산업, 소개 정보, 프로필 사진)와 관련이 있습니다.
2단계: 클라이언트 사용 시작하기
등록
온프레미스 API 클라이언트가 설치 및 실행되면 account 엔드포인트로 API 호출을 보내 전화번호를 등록할 수 있습니다.
테스트 메시지 전송
messages 엔드포인트를 사용하여 테스트 메시지를 전송할 수 있습니다. 먼저 테스트에 사용할 전화번호의 상태를 확인합니다. 테스트 전화번호에서 WhatsApp 계정으로 메시지를 보내 고객 서비스 창을 활성화해야 합니다. 그러면 24시간 이내에 모든 유형의 메시지를 전송할 수 있게 됩니다(자세한 내용은 컷오프 제어 참조). 그런 다음 테스트 전화번호로 문자 메시지를 전송합니다. 메시지가 도착하면 설치가 성공했다는 의미입니다. 메시지가 도착하지 않으면 Webhooks에 문제가 있는지 알려주는 알림이 왔는지 확인하세요.
보안
온프레미스 API 클라이언트와 관련된 비밀번호, 인증, SSL 구성, 네트워크 분리, 암호화된 통신, HTTP 헤더 및 웹 서버 TLS 프로토콜에 대한 내용은 보안 가이드를 참조하세요.
시작 프로세스
WhatsApp 온프레미스 API는 서버와의 연결을 설정하자마자 시작 프로세스를 수행합니다. 이 프로세스는 메시지를 주고받기 위한 안정적이고 원활한 수단을 보장하는 데 반드시 필요합니다. 이 시작 단계에서 코어 앱(coreapp)은 다음과 같은 여러 가지 필수 조건이 충족되기를 기다립니다.
템플릿 메시지 읽어들이기: API가 초기화 프로세스를 진행하는 과정에서 서버로부터 템플릿 메시지를 읽어들입니다.
오프라인 메시지 수신 및 처리: 오프라인 메시지를 수신하고 처리하는 작업도 수행합니다.
이러한 필수 조건이 충족되지 않은 채 메시지를 전송하려고 시도하면 코어 앱은 'Coreapp이 준비되지 않음' 오류 메시지로 응답하고, 로그에 '서비스가 준비되지 않음' 오류가 표시됩니다. 이 시작 프로세스는 WhatsApp 서버에서 새로운 연결이 설정될 때마다 실행된다는 점에 유의해야 합니다. 따라서 코어 앱이 다시 시작되거나 연결이 끊기는 경우, coreapp 상태를 'ready'로 설정하기 위해 시작 프로세스가 다시 시작됩니다. 이를 통해 메시지 통신에 대한 WhatsApp 온프레미스 API의 안정성과 준비성이 보장됩니다.
오프라인 메시지 처리
오프라인 메시지를 찾을 수 없는 경우, 오프라인 메시지 처리 단계는 생략됩니다. 즉, 오프라인 상태에서 대기 중인 메시지가 없을 경우 이 특정 메시지 처리 단계가 우회됩니다.
일반적인 조건에서 WhatsApp 온프레미스 API는 오프라인 메시지 처리를 위한 표준 프로토콜을 따릅니다. 모든 오프라인 메시지를 수신하고 처리하기를 기다리는데, 사전 정의된 최대 제한 시간은 6분입니다. 이 6분간의 시간이 지나면 오프라인 메시지 처리 단계가 성공적으로 완료된 것으로 간주됩니다.
추가 제안
권장 사항먼저 내부 직원과 메시지를 주고받으면서 시스템이 작동하는지 확인합니다. 모든 고객에게 24시간 이내에 응답합니다. WhatsApp Business 정책 및 WhatsApp 커머스 정책에 기재된 Meta 정책을 준수합니다. 개발, 테스트, 프로덕션에 여러 전화번호를 사용합니다. 기술 지원 티켓을 개설하기 전에 FAQ를 확인합니다. 제품 피드백을 제공합니다. 기술 지원은 피드백을 제공하는 가장 좋은 채널입니다. | 금지 사항여러 채널로 중복된 알림을 전송하지 않습니다. 스팸을 보내지 않습니다. 테스트 목적으로 1-800 번호를 사용하지 않습니다. WhatsApp 통합을 위한 목적만으로 비즈니스 관리자를 만들지 않습니다. 기존 비즈니스 관리자를 사용하세요(있는 경우). |
Facebook의 가이드라인이나 정책을 위반한 사실이 발견되면 Facebook에서는 WhatsApp 액세스 권한을 제한하거나 삭제할 권리가 있습니다.