쿨에스엠에스
  • Documents for COOLSMS Developers
  • AUTHENTICATION
    • Overview
    • API Key 인증 방식
    • OAuth2 인증 방식
      • 적용하기
      • 권한(Scope) 목록
    • 멤버 권한 목록
  • DEVELOPMENT-KITS
    • C#
    • DB연동 Agent
    • Go
    • Java
    • Node JS
    • Others
    • PHP
    • Python
    • Ruby
    • Visual Basic .NET
    • Visual Basic 6
  • APP-STORE
    • 쿨에스엠에스 OAuth2 연동 Node & Express를 이용하여 앱 만들기
    • 쿨에스엠에스 앱 스토어에 내가 만든 앱 등록하기
  • API REFERENCE
    • Overview
    • 메시지
      • 여러건 발송
      • 단일 메시지
      • 그룹 메시지
        • 그룹 생성
        • 그룹 메시지 추가
        • 그룹 메시지 목록 조회
        • 그룹 메시지 삭제
        • 발송 요청
        • 그룹 목록 조회
        • 그룹 정보 조회
        • 그룹 삭제
      • 메시지 조회
      • 통계 조회
      • 통계 엑셀 파일 다운로드
    • 카카오톡
      • 템플릿을 삭제
      • 카테고리 정보 조회
      • 카카오톡채널 조회
      • 카카오톡채널 목록 조회
      • 템플릿 정보 조회
      • 템플릿 목록 조회
      • 템플릿 숨김 설정
      • 카카오톡채널 추가
      • 템플릿 추가
      • 템플릿 댓글 추가
      • 카카오톡채널 연동 토큰 신청
      • 템플릿 정보 수정
      • 템플릿 검수 요청
    • 잔액
      • 잔액이전
      • 사용자 충전
      • 은행 계좌 등록
      • 결제수단 등록
      • 출금 신청
      • 등록된 계좌 정보 삭제
      • 결제 수단 제거
      • 잔액조회
      • 잔액 변동내역 조회
      • 계좌 정보 조회
      • 견적서 발급
      • 알림 설정 조회
      • 결제수단 목록 조회
      • 거래명세서 발급
      • 출금 요청 상태 조회
      • 등록된 결제수단의 우선순위를 변경
      • 잔액 소진 알림 설정
      • 잔액 소진 알림 on/off 설정
      • 자동 충전 on/off
    • 가격
      • 하나의 국가의 메시지 단가 가져오기
      • 국가별 메시지 가격 리스트 가져오기
    • 스토리지
      • 파일 삭제
      • 파일 조회
      • 파일 목록 조회
      • 파일 업로드
    • 메시지 상태 코드
    • Terminology
  • OLD-VERSIONS
    • SMS API Version 1
    • SMS API Version 2
  • OLD-VERSIONS-SDK
    • C
    • Delphi
      • API Reference
      • Examples
    • java
    • JAVA
    • java
    • PHP
      • PHP SDK v2
        • Example
    • python
    • Python
    • python
    • 에러코드 참고
Powered by GitBook
On this page
  • Authorization?
  • API 사용 조건
  • 계정 권한
  • 회원 권한
  • 계정 상태
  • 회원 상태
  • 계정 인증
Export as PDF
  1. AUTHENTICATION

Overview

PreviousDocuments for COOLSMS DevelopersNextAPI Key 인증 방식

Last updated 5 years ago

Authorization?

COOLSMS에서는 공식 사이트() 이외에도 사용자(혹은 개발자)가 서비스를 이용할 수 있도록 API를 제공하고 있습니다. 제공된 API를 사용하기 위해서는 자신이 누구인지(COOLSMS 앱의 경우에는 앱 사용자를 대신해서) 알리기 위해서 몇 가지 인증 방식을 사용하여 정보를 제공해야 됩니다. 그 과정을 Authorization이라고 합니다.

Authorization은 인증 방식을 통합적으로 나타내는 말이기도 합니다. COOLSMS에서는 직접연동인 과 , 총 두 가지 인증 방식을 제공합니다.

API 사용 조건

인증을 통해 COOLSMS가 제공하는 API를 사용하는 경우 서버는 5가지의 조건을 따지게 됩니다. 조건은 아래와 같습니다.

계정 권한

OAuth2를 사용하려고 하는 앱 개발자에게만 해당되는 내용입니다.

COOLSMS는 정식 서비스 이외에도 문자 서비스를 제공하는 앱(이하 서드파티 앱)을 만들 수 있도록 설계되어 있습니다. 서드파티앱은 하며 개발자가 원한다면 할 수 있습니다. 또한 개발자는 COOLSMS와 수익을 공유하게 됩니다.

서드파티앱을 만들 경우 개발자는 앱 사용자로부터 사용자 대신 사용자의 정보(예: 캐쉬 정보)를 얻을 수 있는 권한이나 계정을 활용(예: 문자 보내기) 할 수 있는 권한을 요청할 수 있습니다. 각각의 API는 필요로 하는 권한이 있으며 앱 개발자가 사용자에게 요청을 하지 않은 경우 혹은 요청을 했지만 허용하지 않은 경우 사용이 불가합니다. 권한을 많이 요청할 수록 COOLSMS가 제공하는 많은 기능과 API들을 활용할 수 있지만 무분별한 권한 요청은 오히러 사용자가 앱 사용을 꺼려할 수 있습니다. 자세한 내용은 을 참고 해주세요.

회원 권한

COOLSMS 서비스는 계정과 회원이 존재하며 계정은 마치 그룹과 같아 여러 회원들이 속해 있을 수 있습니다. 그리고 계정에 속한 회원들은 각자의 역할을 가지며 그 역할에 따라 계정에 영향을 미칠 수 있는 정도가 나뉩니다. 역할은 크게 OWNER, DEVELOPER, MEMBER 총 3개로 나뉩니다. 만약 사용자가 계정을 사용할 때 충분한 권한이 없다면 사용이 제한됩니다. 자세한 내용은 을 참고 해주세요.

계정 상태

COOLSMS의 계정은 여러 가지의 상태를 가질 수 있습니다. 상태는 ACTIVE, INACTIVE, DELETED가 존재합니다.

ACTIVE: 사용 가능 상태. 대부분의 계정은 ACTIVE 상태를 유지합니다.

INACTIVE: 휴면 계정 상태. 1년 동안 사용 기록이 없는 계정은 이용약관에 따라 휴면 상태가 됩니다. 이때는 계정에 속한 회원이 인증을 통해 다시 ACTIVE 상태로 돌릴 수 있습니다.

DELETED: 삭제된 계정. 계정의 OWNER 혹은 관리자에 의해서 삭제된 계정입니다. 복구가 불가능하며 모든 서비스를 이용할 수 없습니다.

회원 상태

계정에 속한 회원은 여러 가지의 상태를 가질 수 있습니다. 상태는 UNVERIFIED, ACTIVE, INACTIVE, DELETED가 존재합니다.

UNVERIFIED: 아직 EMAIL 인증이 안된 회원입니다.

ACTIVE: 사용 가능 상태. 대부분의 회원 ACTIVE 상태를 유지합니다.

INACTIVE: 휴면 회원 상태. 1년 동안 사용 기록이 없는 회원은 이용약관에 따라 휴면 상태가 됩니다. 인증을 통해 다시 ACTIVE 상태로 돌릴 수 있습니다.

DELETED: 삭제된 회원. 본인 혹은 관리자에 의해서 삭제된 계정입니다. 복구가 불가능하며 모든 서비스를 이용할 수 없습니다.

계정 인증

회원은 계정을 사용하기 전 계정을 누가 사용하는지 증명해야 됩니다. 인증은 개인 인증, 사업자 인증 총 2가지가 존재합니다. 계정 인증을 마치지 않은 회원은 API 사용에 제한이 있을 수 있습니다.

https://coolsms.co.kr
API Key 인증 방식
OAuth2 인증 방식
APP STORE
누구나 개발이 가능
누구나 사용
권한 목록
회원 권한 목록