2.1 인증

목차

• 1. 소개
• 2. 호스트 정보
• 3. 인증 방식
• 4. 요청 가이드
• 5. 인증 요청 API
• 6. 인증 갱신 API
• 7. 결과 코드

---

1. 소개

이 문서는 Restful API(v1.0)에 대한 호스트 정보와 요청 방법을 설명합니다. API는 OpenAPI 3.0.1 규격을 따르며, JWT 기반 인증을 사용합니다. API 호출 전 클라이언트 인증을 통해 접근 토큰을 발급받아 API를 이용하실 수 있습니다. 인증 절차는 보안을 위해 필수적이며, 발급된 토큰은 일정 시간 후 만료되어 갱신이 필요합니다.

---

2. 호스트 정보

API 서버는 다음 URL에서 접근할 수 있습니다:

서버 URL	설명
https://api.msghub.uplus.co.kr	기본 API 서버

모든 API 요청은 위의 기본 URL을 통해 이루어집니다.

---

3. 인증 방식

모든 API 요청은 Bearer 인증 방식을 통한 보안이 적용되어 있습니다.

• 인증 유형: HTTP Bearer
• 스키마: bearer
• 형식: JWT(JSON Web Token)
• 헤더 설정: 모든 요청에 다음 인증 헤더를 포함해야 합니다.

  Authorization: Bearer {YOUR_JWT_TOKEN}

---

4. 요청 가이드

API를 호출할 때 다음 가이드라인을 따르십시오:

기본 요청 구조

GET|POST|PUT|DELETE https://api.msghub.uplus.co.kr/{endpoint}
Authorization: Bearer {your_jwt_token}
Content-Type: application/json

요청 파라미터 엔드포인트에 따라 다음과 같은 방식으로 파라미터를 전달할 수 있습니다:

• URL 경로 파라미터
• 쿼리 파라미터
• 요청 본문(JSON)

---

5. 인증 요청 API

기능 설명: 클라이언트 아이디 인증을 요청합니다.

---

1) 요청 (Request)

URL

POST /auth/v1/{randomStr}

Method

POST

Path 파라미터

파라미터	타입	필수	설명	크기
randomStr	String	●	임의 문자열 (영문자, 숫자, -, _ 조합)	최대 20자

Request Body

필드명	타입	필수	설명	크기
apiKey	String	●	API 키	최대 20자
apiPwd	String	●	API 패스워드 (암호화 처리 필요)	-

📌 참고사항

• apiPwd는 다음과 같이 암호화하여 전송해야 합니다: SHA512.encryptToBase64( SHA512.encryptToBase64(apiPwd) + "." + randomStr )

---

2) 응답 (Response)

Response Body

{
  "code": "10000",
  "message": "성공",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

---

3) 요청 예시 (Sample)

Request Payload

{
  "apiKey": "API0jdkQ",
  "apiPwd": "LLp6C9PLBr4Rs5bp1XWkyVaRNx1oxIMpiw..."
}

---

6. 인증 갱신 API

기능 설명: 클라이언트 아이디 인증을 갱신합니다.

📌 주의사항

refresh 토큰의 ipAddr과 요청 서버의 ipAddr이 동일해야 합니다.

---

1) 요청 (Request)

URL

PUT /auth/v1/refresh

Method

PUT

(요청 시 Authorization 헤더에 유효한 Refresh Token을 포함해야 합니다.)

---

2) 응답 (Response)

Response Body

{
  "code": "10000",
  "message": "성공",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }
}

---

3) 요청 예시 (Sample)

Curl

curl -X PUT https://api.msghub.uplus.co.kr/auth/v1/refresh \\
  -H "Authorization: Bearer {YOUR_REFRESH_TOKEN}"

---

7. 결과 코드

• 결과 코드