Kakao i Agent SDK::Wallpad::개발 프로세스::사전작업

페이지 이동경로

사전 작업

SDK를 사용하여 고객사의 Wallpad 애플리케이션에 Kakao i 음성 인식 서비스를 구현하기 전에 다음의 사전 작업을 필수로 수행해야 합니다.

개발 Phase 정의

고객사의 개발 환경과 목적에 따라 담당 Kakao i PM과 사용할 개발 Phase를 정의합니다.

개발 Phase 정보
Phase 필수 여부 설명
Sandbox 선택 개발용 서버
- 필수가 아닌 선택적으로 사용할 수 있는 Phase
- Kakao i PM과 상의하여 사용 여부 결정 필요
Stage 필수 실제 서비스와 Database를 공유하는 Close Beta Test 서버
Real 필수 실제 서비스용 서버

안내
Sandbox Phase는 고객사의 개발 환경을 고려하여 필요한 경우에 사용하는 선택 Phase입니다.

  • Sandbox 개발 Phase와 관련한 자세한 사항은 Kakao i PM과 협의하시기 바랍니다.

패키지명 생성

개발 Phase가 정의된 후, Wallpad 서비스와 채널 분기를 위해 개발 Phase에 따른 애플리케이션의 패키지명을 생성해야 합니다.
생성한 패키지명은 Kakao Developers > 내 애플리케이션 > 앱 설정 > 플랫폼 메뉴에 입력하는 정보이자, 앱서버 등록 요청을 위해 Kakao i PM에게 전달해야 하는 정보입니다.

패키지명 생성
Phase 필수 여부 설명
Sandbox 선택 com.{고객사명}.kakaoi.sandbox
- 개발 Phase 정의 단계에서 Sandbox Phase를 사용하기로 협의된 경우에만 생성
Stage 필수 com.{고객사명}.kakaoi.stage
Real 필수 com.{고객사명}.kakaoi.real

계정 생성 및 앱 등록

개발중인 애플리케이션을 Kakao i 앱 서버에 등록하기 위해, 고객사 애플리케이션을 Kakao Developers에 등록하고, 앱 키(App Key) 등의 애플리케이션(앱)의 기본 정보를 획득해야 합니다.

Kakao Developers 계정 생성

Kakao Developers에서 제공하는 서비스를 사용하기 위해, 카카오 계정으로 회원가입 또는 로그인을 진행해야 합니다.

안내
이 과정은 개발 Phase 정의 단계에서 Kakao i PM과 협의한 개발 Phase별로 각각 진행해야 합니다.

  • Sandbox, Stage, Real Phase를 모두 사용할 경우에는 각 Phase별 Kakao Developers 사이트에서 계정을 생성해야 합니다.
  1. Kakao Developers 사이트로 이동 후, [로그인] 버튼을 클릭합니다. Kakao Developers 그림Kakao Developers

    Phase 별 Kakao Developers 접속 정보
    Phase 접속 정보
    Sandbox/
    Stage
    https://sandbox-developers.kakao.com/
    - 고객사의 IP를 ACL(Access Control List) 추가 완료 시 접속 가능
    Real https://developers.kakao.com/
  2. 카카오 계정 화면에서 [회원가입] 버튼을 클릭합니다.

    카카오 계정 로그인 그림카카오 계정 로그인

  3. 카카오 계정의 이메일이 존재할 경우에는 [이메일이 있습니다.] 버튼을 클릭합니다.

    • 카카오 계정이 없을 경우에는 신규 계정을 생성하시기 바랍니다.

    카카오 계정 회원가입 그림카카오 계정 회원가입

    안내
    카카오 계정 생성 시에는 회사의 공용(마스터) 계정 사용을 권장드립니다.
  4. 카카오 계정 서비스약관 항목을 선택하고, [동의] 버튼을 클릭합니다.

    카카오 계정 서비스약관 동의 그림카카오 계정 서비스약관 동의

  5. 정보를 모두 기입한 후에 [다음] 버튼을 클릭합니다.

    카카오 계정 정보 입력 그림카카오 계정 정보 입력

  6. 최초 로그인의 경우, 회원가입 화면에서 서비스 이용 동의를 진행하고 [회원가입] 버튼을 클릭합니다.

    Kakao Developers 최초 로그인 시 서비스 이용 동의 그림Kakao Developers 최초 로그인 시 서비스 이용 동의

애플리케이션 등록

카카오 계정 생성을 완료 후 개발 중인 애플리케이션을 등록합니다.

  1. 내 애플리케이션 메뉴를 클릭 후, [애플리케이션 추가하기]를 클릭합니다.

    애플리케이션 추가하기 그림애플리케이션 추가하기

  2. 애플리케이션 추가하기 팝업창이 나타나면, 정보를 입력하고 [저장] 버튼을 클릭합니다.

    애플리케이션 추가하기 그림애플리케이션 추가하기

    애플리케이션 추가하기 구성 항목
    항목 필수 여부 설명
    앱 아이콘 필수 앱 아이콘 대표 이미지
    - 업로드 이후 수정 가능
    앱 이름 필수 카카오 로그인 창에 표시되는 앱의 이름
    - 형식: {고객사명} 월패드(ex. abcCompany 월패드)
    사업자명 필수 카카오 로그인 창에 표시되는 회사 이름
  3. 제품 설정 > 카카오 로그인으로 이동 후 [활성화] 버튼을 클릭하여 설정을 활성화 합니다.

    카카오 로그인 활성화 그림카카오 로그인 활성화

  4. [Redirect URI 등록] 버튼을 클릭하고, 다음의 커넥트웹 서버의 Redirect URI 주소를 작성 후 [저장] 버튼을 클릭합니다.

    코드예제Redirect URI

    https://stage-connect.i.kakao.com/oauth
    https://connect.i.kakao.com/oauth
    

    Redirect URI 등록 그림Redirect URI 등록

  5. 카카오 로그인 > 동의항목 메뉴로 이동 후 닉네임과 프로필 사진을 설정합니다.

    a. 닉네임 열에서 [설정] 버튼을 클릭 후, 필수 동의를 선택하고 동의 목적을 작성합니다.
    ex. abc Wallpad에서 Kakao i Agent SDK 사용

    카카오 로그인 사용 설정(닉네임) 그림카카오 로그인 사용 설정(닉네임)

    b. 프로필 사진 열에서 [설정] 버튼을 클릭 후, 필수 동의를 선택하고 동의 목적을 작성합니다.
    ex. 동의 목적 예시: abc Wallpad에서 Kakao i Agent SDK 사용

    카카오 로그인 사용 설정(프로필 사진) 그림카카오 로그인 사용 설정(프로필 사진)

  6. 앱 설정 > 플랫폼 메뉴에서 [Android 플랫폼 등록] 버튼을 클릭하고, 다음 항목을 기입 후 [저장] 버튼을 클릭합니다.

    Android 플랫폼 등록 그림Android 플랫폼 등록

    Android 플랫폼 등록 팝업 구성 요소
    항목 필수 여부 설명
    패키지명 필수 패키지명 생성에서 정의한 패키지 이름
    - sandbox: com.{고객사명}.kakaoi.sandbox
    (sandbox 패키지명은 해당 Phase를 사용할 경우에만 생성 필요)
    - stage: com.{고객사명}.kakaoi.stage
    - real: com.{고객사명}.kakaoi.real
    마켓 URL 필수 패키지명 입력 시 자동 생성됨
    키 해시 선택 Kakao Developers > 키 해시 등록 문서를 참고하여 키 해시 값 등록
  7. [Web 플랫폼 등록] 버튼을 클릭하고, 다음의 사이트 도메인을 입력한 후 [저장] 버튼을 클릭합니다.

    코드예제Web 플랫폼 도메인

    https://stage-connect.i.kakao.com
    https://connect.i.kakao.com
    

    Web 플랫폼 등록 그림Web 플랫폼 등록

앱 기본 정보 전달

Kakao Developers에서 애플리케이션 등록을 완료한 후, 별도로 안내된 협업 아지트에 접속하여 담당자인 Kakao i PM에게 앱서버 등록을 요청해야 합니다. 앱 서버 등록을 위해서는 앱 키(App Key) 정보가 필요하므로, 협업 아지트에 앱 서버 등록을 요청 시 상기 단계에서 획득한 앱 키 정보를 함께 전달하시기 바랍니다.

  1. 사전에 Kakao i PM에게 안내받은 협업 아지트로 접속합니다.

  2. 사전에 정의한 Phase별로 아래 템플릿을 복사/작성 후 앱 서버 등록 요청을 진행합니다.

    안내
    Sandbox Phase의 경우에는 ACL(Access Control List) 추가를 위해 고객사 IP 정보가 필요합니다.

코드예제[템플릿] Phase별 전달할 앱 기본 정보

  1. 앱 이름:
  2. 네이티브 앱 키:
  3. REST API 키:
  4. JavaScript 키:
  5. Admin 키:
  6. 애플리케이션(앱) ID:
  7. 패키지명:
  1. 앱 이름:
  2. 네이티브 앱 키:
  3. REST API 키:
  4. JavaScript 키:
  5. Admin 키:
  6. 애플리케이션(앱) ID:
  7. 패키지명:
  8. 고객사 IP:

템플릿 작성 정보 확인

템플릿에 작성해야 하는 정보는 다음의 경로에서 확인하실 수 있습니다.

  • 앱 키 정보: Kakao Developers > 앱 설정 > 앱키 메뉴 앱 키 정보 확인 그림앱 키 정보 확인

    주의
    앱 키(App Key) 정보가 외부로 유출될 경우에는 해킹 등 악용의 소지가 발생할 수 있으므로, GitHub와 같은 코드 저장소에 노출되지 않도록 주의하시기 바랍니다.
  • 패키지명: 패키지명 생성 단계 에서 정의한 패키지명 (ex. com.{고객사명}.kakaoi.{Phase} 형식)

이 문서가 만족스러운 이유를 알려주세요.
이 문서에 아쉬운 점을 알려주세요.
평가해주셔서 감사합니다.

더 자세한 의견은 documentation@kakaoenterprise.com 으로 제보해주세요.