연관 가이드

[태그미] [프라이빗 모드] 개발자센터

[프라이빗 모드] 굿즈 소유자만 볼 수 있는 프라이빗 모드

[프라이빗 모드] 활성화 및 스크립트 코드 복사하기

목차

1. 문서 버전

버전	변경 일자	변경 내용	작성자
1.0	2024-12-23	초안 작성	이희수

2. 공통 사항

HOST

<aside>

운영 : https://service-api.tagme.my

</aside>

공통 Request

<aside>

Accept: /

Content-Type: application/json

</aside>

성공 Response

{
  "statusCode": 200,
  "message": "SUCCESS",
  "data": {}
}

key	type	설명
statusCode	integer	HttpsStatusCode
message	string	응답 메시지
data	Result	응답 데이터

실패 Response

{
  "errorCode": "ERROR_CODE",
  "message": "에러 이유"
  "fieldErrors": {
    "fieldName": "reason"
  }  
}

key	type	설명
errorCode	string	에러 코드
message	string	에러 이유
fieldErrors		필드 에러
→ 필드 에러가 존재하는 경우에만 응답에 포함
filedName	String	필드 이름

3. API 목록

1. UID 반환

URL

**POST** /v1/tagme-open/uid/

RequestBody

{
  "projectCode": "string",
  "secretCode": "string",
  "nfc": {
    "picc": "string",
    "enc": "string",
    "mac": "string"
  }
}

key	type	설명
projectCode	string	프로젝트 고유 코드
secretCode	string	시크릿 코드
picc (picc_data)	string
enc (enc)	string
mac (cmac)	string

Response

{
  "statusCode": 200,
  "message": "성공",
  "data": {
    "uid": "string"
  }
}

key	type	설명
uid	string	nfc의 유니크한 id 값

✔️ API Key 란?

picc, enc, mac를 통해 특정 유저의 UID를 도출하고 이를 비즈니스에 활용하기 위해 사용하는 API 입니다.

→ UID에 대한 맞춤형 데이터 제공이 필요하다면 API Key를 활용해보세요.

✔️ 사용 방법

프로젝트가 Private 모드인 경우에만 사용이 가능합니다
NFC 정보를 Request Param 으로 전송해야 합니다.
- 주소창 링크를 통해 picc, enc, mac 확인
프로젝트 코드와 시크릿 코드를 Request Param 으로 전송해야 합니다.
- 사이트 내 위치 확인

✔️ API 응답이 실패하는 경우

프로젝트가 Private 모드가 아닌 경우
projectCode와 secretCode가 매치되지 않는 경우
전달된 NFC 관련 정보로 uid를 반환할 수 없는 경우

→ 보안상의 이유로 실패 사유에 대한 세부 정보는 제공되지 않으며, 모든 실패 케이스에 대해 동일한 응답이 반환됩니다.