작성: 21YunBox 중국 엔지니어링 팀 · 게시 2020년 7월 2일

이 웹 서비스를 사용하여 중국을 위한 SMS 기반 로그인 시스템을 구축하세요.

API 기본 URL

담당 계정 매니저가 기본 URL을 배정해 드립니다. 아래 엔드포인트와 함께 사용하여 인증 서비스에 접근하세요.

엔드포인트: POST /get-code

이 API를 사용하여 사용자의 휴대폰으로 SMS 인증 코드를 보냅니다.

요청:

  • HTTP 메서드: POST
  • 형식: JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>"
}

응답(성공 시)

{
    "status": "ok",
    "phone_no": "<PHONE_NO>"
}

응답(실패 시)

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

필드

  • key: 담당 계정 매니저가 배정한 API 키.
  • phone_no: 인증 코드가 전송될 사용자 전화번호.
  • status: 요청이 성공하면 ok를 반환.
  • code: 요청 실패 시 반환되는 오류 코드. 자세한 내용은 오류 코드 섹션 참고.
  • msg: 요청 실패 시 반환되는 짧은 메시지. 자세한 내용은 오류 코드 섹션 참고.

오류 코드와 정의

  • 0070: 요청 형식이 JSON이 아님.
  • 0072: JSON에 phone_no 또는 key 인수 누락.
  • 0073: 유효하지 않은 키. API 키를 받으려면 담당 계정 매니저에게 문의.
  • 0075: 유효하지 않은 전화번호.
  • 0077: 테스트 전화번호.

엔드포인트: POST /check-code

유효한 SMS 인증 코드가 입력되면 이 API를 사용하여 로그인하거나 새 사용자를 등록합니다.

요청

  • HTTP 메서드: POST
  • 형식: JSON
{
    "key": "<API_KEY>",
    "phone_no": "<PHONE_NO>",
    "user_input_code": "..."
}

응답(성공 시)

{
  "status": "ok",
  "yb_uid": "<>"
}

응답(실패 시)

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

필드

  • key: 담당 계정 매니저가 배정한 API 키.
  • phone_no: 인증 코드가 전송될 사용자 전화번호.
  • user_input_code: 사용자가 입력한 코드.
  • status: 요청이 성공하면 ok를 반환.
  • yb_uid: 사용자가 성공적으로 등록·로그인되면 반환. 이 UID를 앱에 전달하여 암호화 연결을 활성화하세요.
  • code: 요청 실패 시 반환되는 오류 코드. 자세한 내용은 오류 코드 섹션 참고.
  • msg: 요청 실패 시 반환되는 짧은 메시지. 자세한 내용은 오류 코드 섹션 참고.

오류 코드와 정의

  • 0070: 요청 형식이 JSON이 아님.
  • 0072: JSON에 phone_no 또는 key 인수 누락.
  • 0073: 유효하지 않은 키. API 키를 받으려면 담당 계정 매니저에게 문의.
  • 0075: 유효하지 않은 전화번호.
  • 0076: SMS 인증 코드 형식이 유효하지 않음.
  • 0077: 유효하지 않거나 만료된 코드.
  • 0078: 시스템 오류. 암호화 연결 구성 생성 실패.
  • 0079: 시스템 오류. 암호화 연결 구성 생성 실패.
  • 0100: 계정 잔액 부족.
  • -1: 예기치 않은 시스템 오류.

테스트 전화번호와 코드

테스트 목적으로만, 이 전화번호와 SMS 인증 코드를 사용하여 인증 과정을 건너뛸 수 있습니다.

{
    "key": "<API_KEY>",
    "phone_no": "12345678910",
    "user_input_code": "4433"
}

엔드포인트: POST /u/<yb_uid>/devices

이 API를 사용하여 사용자를 위한 새 기기를 생성합니다.

요청

  • HTTP 메서드: POST
  • 형식: JSON
{
    "key": "<API_KEY>"
}

응답(성공 시)

{
  "status": "ok",
  "device_id": "<DEVICE_ID>"
}

응답(실패 시)

{
    "code": "<ERROR CODE>",
    "msg": "<MESSAGE>"
}

필드

  • key: 담당 계정 매니저가 배정한 API 키.
  • status: 요청이 성공하면 ok를 반환.
  • device_id: 새 기기가 성공적으로 생성되면 반환. 이 ID를 앱에 전달하여 암호화 연결을 활성화하세요.
  • code: 요청 실패 시 반환되는 오류 코드. 자세한 내용은 오류 코드 섹션 참고.
  • msg: 요청 실패 시 반환되는 짧은 메시지. 자세한 내용은 오류 코드 섹션 참고.

오류 코드와 정의

  • 0070: 요청 형식이 JSON이 아님.
  • 0071: JSON에 key 인수 누락.
  • 0073: 유효하지 않은 키. API 키를 받으려면 담당 계정 매니저에게 문의.
  • 0078: 시스템 오류. 암호화 연결 구성 생성 실패.
  • 0079: 시스템 오류. 암호화 연결 구성 생성 실패.
  • 0200: 유효하지 않은 UID.
  • 0202: 사용자가 존재하지 않음.
  • -1: 예기치 않은 시스템 오류.

엔드포인트: GET /u/<yb_uid>/devices

이 API를 사용하여 사용자가 소유한 기기 목록을 가져옵니다.

요청

  • HTTP 메서드: GET

응답(성공 시)

{
  "status": "ok",
  "device_ids": [
      "<DEVICE_ID_1>",
      "<DEVICE_ID_2>",
      ...
  ]
}

응답(실패 시)

{
    "code": "<ERROR_CODE>",
    "msg": "<MESSAGE>"
}

필드

  • status: 요청이 성공하면 ok를 반환.
  • device_ids: 사용자가 소유한 기기 목록을 반환. 가장 최근에 생성된 10개 기기만 표시됩니다.
  • code: 요청 실패 시 반환되는 오류 코드. 자세한 내용은 오류 코드 섹션 참고.
  • msg: 요청 실패 시 반환되는 짧은 메시지. 자세한 내용은 오류 코드 섹션 참고.

오류 코드와 정의

  • 0200: 유효하지 않은 UID.
  • 0202: 사용자가 존재하지 않음.
  • -1: 예기치 않은 시스템 오류.

21YunBox를 사용해 보시겠어요?

상담 신청