API Key 발급

API key를 발급하기 위한 엔드포인트를 제공하고 있습니다. 마이페이지에 기재된 서비스 ID와 서비스 비밀번호로 API key를 발급할 수 있습니다. 또한, 마이페이지에서 'API キー発行可能' API key 발급가능으로 설정하여 발급한 API key로도 API key를 발급할 수 있습니다.

• API key는 애플리케이션이 AmiVoice API 음성 인식 서비스를 이용하기 위한 서비스 인증 키 문자열입니다.
• 발급 일시와 유효 시간에 기반한 유효기간 일시 또는 이용 가능한 IP 주소를 필요에 따라 설정할 수 있습니다.

엔드포인트

POST https://acp-api.amivoice.com/issue_service_authorization

요청

요청 파라미터

파라미터명	필수	설명
sid	*1	마이페이지의 接続情報 연결 정보에 표시되는 サービスID 서비스 ID를 지정합니다. authorization으로 API key를 지정하는 경우 sid는 지정하지 마십시오.
spw	*1	마이페이지의 接続情報 연결 정보에 표시되는 サービスパスワード 서비스 비밀번호를 지정합니다. authorization으로 API key를 지정하는 경우 spw는 지정하지 마십시오.
authorization	*2	마이페이지에서 'API キー発行可能" API key 발급 가능으로 설정하여 발급한 API key를 지정합니다. Authorization 헤더에 지정해 주십시오. authorization을 사용하는 경우 sid와 spw는 지정하지 마십시오.
epi		유효기간. 발급하는 API key의 사용 기한을 지정합니다. 생략 시에는 30000(30초)이 설정됩니다.
ipa		연결 원본 IP 주소. API key를 이용할 수 있는 클라이언트의 IP 주소에 제한을 둘 수 있습니다

• (*1) authorization을 지정하지 않는 경우 필수입니다.
• (*2) sid와 spw를 지정하지 않는 경우 필수입니다.

노트

서비스 비밀번호와 마이페이지 로그인용 비밀번호는 다릅니다.

유효기간

다음 중 하나를 지정할 수 있습니다.

• 숫자. 밀리초 단위의 사용 기한이 됩니다.
• 's' (초), 'm' (분), 'h' (시간), 'd' (일), 'w' (주)를 단위로 하는 문자열. 예를 들어, 다음과 같이 지정할 수 있습니다.

5m                  5분
2h                  2시간
100d                100일

• yyyy(/|-)mm(/|-)dd[( |T)hh:mm:ss[.sss][[ ](Z|(+|-)zz[[:]zz])]] 형식의 시각을 나타내는 문자열. 예를 들어, 다음과 같이 지정할 수 있습니다.

2021/06/30            2021년 6월 30일 24시 0분 0초 (2021년 7월 1일 0시 0분 0초)까지 유효
2021/07/00            2021년 6월 30일 24시 0분 0초 (2021년 7월 1일 0시 0분 0초)까지 유효
2021/05/15 12:05:30   2021년 5월 15일 12시 5분 30초까지 유효

연결 원본 IP 주소

다음 중 하나를 지정할 수 있습니다.

• 빈 문자열
• 공백 또는 ,(쉼표)를 구분자로 하는 여러 IPv4 CIDR 형식의 IP 주소를 나타내는 문자열. 예를 들어, 다음과 같이 지정할 수 있습니다.

10.1.2.34
192.168.0.0/16
150.249.206.220 150.249.236.100/31

응답

성공 시

API key 문자열을 반환합니다.

실패 시

• Authorization 헤더가 Bearer 로 시작하지 않는 경우

상태 코드 400으로 다음 오류 메시지가 반환됩니다

Invalid Authorization Header

• authorization으로 지정한 API key가 올바르지 않은 경우

API key의 인증이 불가능하여 상태 코드 400으로 다음 오류 메시지가 반환됩니다

Invalid appkey

• authorization으로 지정한 API key가 'API キー発行可能' API key 발급 가능으로 설정되어 있지 않은 경우, 또는 비활성화된 경우

API key를 사용한 서비스 비밀번호를 얻을 수 없어 상태 코드 400으로 다음 오류 메시지가 반환됩니다

Dont issue appkey

• 응답이 없는 경우

필수 항목이 지정되지 않았을 가능성이 있으므로 파라미터를 확인해 주십시오.

주의

서비스 ID나 서비스 비밀번호가 잘못되어 있어도 API key가 발급됩니다. 이 잘못된 API key를 사용하여 음성 인식 서비스에 연결하면 인증 오류가 발생합니다. 오류 메시지는 인터페이스 등에 따라 다릅니다.

HTTP 인터페이스의 경우

서비스 ID, 서비스 비밀번호 중 어느 하나라도 잘못된 경우, 타이밍에 따라 다음 중 하나의 오류를 반환합니다.

{
    "code":"-",
    "message":"received illegal service authorization"
}

WebSocket 인터페이스의 경우

서비스 ID, 서비스 패스워드 중 하나가 잘못된 경우, 다음과 같은 오류를 반환합니다.

s can't validate service authorization