개요 #
기업고객과 U+메시지 허브 시스템 간 인증 방식은 JWT(JSON Web Token) 방식 인증을 사용합니다. 인증 후, API 요청 시 헤더의 Authorization 값으로 Bearer {ACCESS_TOKEN}을 포함해야 합니다.
| Token 만료시간 | Token 사전 갱신 권장 시간 | ||
|---|---|---|---|
| Token | 1시간 후 | Token | 만료 10분 전 |
| Refresh Token | 25시간 후 | Refresh Token | 만료 30분 전 |
주의!!
- 해킹방지를 위해 사용하고자 하는 Api key에 최소 1개이상의 발신지 IP 대역을 등록하고 재인증 요청하여 사용합니다. 이때, 인증요청 IP 대역도 포함되어야 합니다.
인증 요청 #
API 키와 암호화된 비밀번호로 인증을 요청합니다.
- 패스워드 암호화 절차 1) apiPwd를 SHA512 + Base64 암호화 2) apiPwd 암호화된 값에 . 및 randomStr 추가후 SHA512 + Base64 암호화 ex) 패스워드 암호화 예제 Base64(SHA512( Base64(SHA512(apiPwd)) + "." + randomStr ) ))
Request
URL
POST /auth/v1/{randomStr} HTTP/1.1
Content-Type: application/json
Host: api.msghub.uplus.co.kr
Path parameter
| Name | Type | Required | Description |
|---|---|---|---|
| randomStr | String | true | Randome Number, 암호화에 사용 (문자,숫자,하이픈,밑줄 허용, 최대20자리) |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| apiKey | String | true | API 키 |
| apiPwd | String | true | 암호화된 비밀번호 |
Response
| Name | Type | Description |
|---|---|---|
| code | String | 인증 요청 결과 코드 |
| message | String | 인증 요청 결과 코드 설명 |
| data | Object | 인증 요청 결과 데이터 |
| data.token | String | 토큰(1시간 만료) |
| data.refreshToken | String | 리프레시 토큰(25시간 만료) |
Sample
Curl
curl -X POST "https://api.msghub.uplus.co.kr/auth/v1/12345"
-H "accept: */*"
-H "Content-Type: application/json"
-d '{
"apiKey": "1",
"apiPwd": "fwxbxKFf7RjMUoSGVJML6YTx..."
}'
Response
{
"code": "10000",
"message": "성공",
"data": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNj...",
"refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxI..."
}
}
참고
결과 코드 참고
인증 갱신 #
인증 토큰을 갱신합니다.
Request
URL
PUT /auth/v1/refresh HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}
Host: api.msghub.uplus.co.kr
Header
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | String | true | 리프레시 토큰 |
Response
| Name | Type | Description |
|---|---|---|
| code | String | 인증 갱신 결과 코드 |
| message | String | 인증 갱신 결과 코드 설명 |
| data | Object | 인증 갱신 결과 데이터 |
| data.token | String | 토큰(1시간 만료) |
Sample
Curl
curl -X PUT "https://api.msghub.uplus.co.kr/auth/v1/refresh" -H "accept: */*" -H "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwi..."
Response
{
"code": "10000",
"message": "성공",
"data": {
"token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZX..."
}
}
참고
결과 코드 참고