GuideReference
v1.0
OAS 3.0.0

Imweb Ground API

Server: https://openapi.imweb.me
Client Libraries
Curl Shell

OAuth2.0

​

OAuth2.0

OAuth2.0 Operations

인가 코드 발급

​
Query Parameters
  • responseType
    Type:string
    required

    OAuth 2.0 인증 요청 타입을 지정합니다.
    "code": 권한 부여 코드 흐름(Authorization Code Flow)을 사용하여 액세스 토큰을 발급받기 위한 인증 코드를 요청합니다.
    현재 서비스에서는 Authorization Code Flow만 지원하므로 "code"로 값이 고정됩니다.

    • code: OAuth 2.0 인가 코드 발급 요청 타입
  • clientId
    Type:string
    required

    아임웹으로부터 발급 받은 클라이언트 앱 ID

  • redirectUri
    Type:string
    required

    인증 코드를 전달 받을 URI, 앱 등록 시 등록한 redirectUri 값
    HTTPS 사용을 권장합니다.

  • scope
    Type:string
    required

    접근이 필요한 권한을 공백으로 구분하여 전달

    • site-info:read: 사이트 정보 읽기
    • site-info:write: 사이트 정보 읽기∙쓰기
    • member-info:read: 회원 정보 읽기
    • member-info:write: 회원 정보 읽기∙쓰기
    • promotion:read: 프로모션 읽기
    • promotion:write: 프로모션 읽기∙쓰기
    • community:read: 커뮤니티 읽기
    • community:write: 커뮤니티 읽기∙쓰기
    • product:read: 상품 읽기
    • product:write: 상품 읽기∙쓰기
    • order:read: 주문 읽기
    • order:write: 주문 읽기∙쓰기
    • payment:read: 결제 읽기
    • payment:write: 결제 읽기∙쓰기
    • script:read: 스크립트 읽기
    • script:write: 스크립트 읽기∙쓰기
  • state
    Type:string

    CSRF 공격 방지를 위한 임의의 문자열

  • siteCode
    Type:string
    required

    사이트 코드

Responses
  • 200
  • application/json
  • default

    Error List Up

    statusCode errorCode message
    500 10000 아임웹 내부 서버에서 에러가 발생했습니다.
    400 10001 잘못된 입력으로 요청하였습니다.
    400 10003 잘못된 데이터로 요청하였습니다.
    400 10004 잘못된 입력으로 요청하였습니다.
    400 30098 클라이언트 정보가 올바르지 않습니다.
    400 30098 클라이언트 정보가 올바르지 않습니다.
    400 30099 요청한 scope가 올바르지 않습니다.
    400 30099 요청한 scope가 올바르지 않습니다.
    401 30101 토큰이 유효하지 않습니다.
    401 30102 토큰이 만료되었습니다.
    403 30103 권한이 부족합니다.
    400 30104 유닛 코드가 유효하지 않습니다.
Request Example forGET/oauth2/authorize
curl 'https://openapi.imweb.me/oauth2/authorize?responseType=code&clientId=9fdb5b45-b4cb-4bae-a1bd-12bad9098744&redirectUri=https%3A%2F%2Fexample.com%2Fcallback&scope=member-info%3Aread%20product%3Awrite%20order%3Awrite&siteCode=S2025012450f7813d2ddau'
No Body

Site-Info (Collapsed)

​

사이트 이름, 기본 도메인, 기본 통화 등 기본 정보를 제공합니다.

Site-Info Operations

Member-Info (Collapsed)

​

회원 정보, 속한 그룹 정보, 보유 프로모션 정보 및 그룹별 회원 목록 정보를 제공합니다.

Member-Info Operations

Models