User API

CREMA 서버에 등록된 회원 정보를 확인하고, 등록/수정하는 방법을 제공합니다.

List users

회원 목록을 가져옵니다.

GET /v1/users HTTP/1.1

Parameters

이름	타입	필수	설명
`limit`	integer	✖	한 페이지의 회원 목록 길이. 범위: 1 ~ 100. 기본: `30`

Response

HTTP/1.1 200 OK
Link: <https://api.cre.ma/v1/users?page=372>; rel="last", <https://api.cre.ma/v1/users&page=2>; rel="next"

[
  {
    "id": 1,
    "name": "홍길동",
    "created_at": "2015-04-17T16:03:05.000+09:00",
    "updated_at": "2015-04-17T16:03:05.000+09:00"
  },
  {
    "id": 2,
    "name": "크레마",
    "created_at": "2015-04-17T16:03:05.000+09:00",
    "updated_at": "2015-11-12T23:22:06.000+09:00"
  },
  {
    "id": 3,
    "name": "가이드",
    "created_at": "2015-04-17T16:03:06.000+09:00",
    "updated_at": "2015-11-12T23:22:23.000+09:00"
  },
]

Get a single user

회원 하나의 상세 정보를 가져옵니다.

with `id`

GET /v1/users/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	회원의 `id`

with `username`

GET /v1/users HTTP/1.1

이름	타입	필수	설명
`username`	string	✔	회원의 쇼핑몰 아이디

Response

HTTP/1.1 200 OK

{
  "id": 1,
  "user_id": "kildong",
  "user_name": "홍길동",
  "allow_sms": false,
  "user_phone": "01012345678",
  "allow_email": false,
  "user_email": "sample@sample.com",
  "user_status": 10,
  "user_grade_id": 2,
  "last_logged_in_at": "2015-04-17T16:03:05.000+09:00",
  "active": true,
  "birth_date": "2000-01-01",
  "joined_at": "2015-04-17T16:03:05.000+09:00",
  "created_at": "2015-04-17T16:03:05.000+09:00",
  "updated_at": "2015-04-17T16:03:05.000+09:00"
}

Create or Update a user

새로운 회원을 생성하거나 기존 데이터를 수정합니다.

POST /v1/users HTTP/1.1

access_token=$ACCESS_TOKEN&user_id=kildong&user_name=홍길동&allow_sms=0&allow_email=0

Parameters

이름	타입	필수	설명
`user_id`	string	✔	회원의 쇼핑몰 아이디. 다른 회원와 중복되면 안됩니다.
`user_name`	string	✔	이름
`created_at`	datetime(ISO 8601)	✖	가입일. 초단위까지만 유효. 타겟 서비스를 이용하는 경우 필수로 입력해야 합니다.
`user_phone`	string	✖	휴대폰 번호. 예시: `010-1234-5678`, `01012345678`
`allow_sms`	integer	✔	SMS 문자 수신 여부. 수신 허용 시 `1`, 수신 거부 시 `0`
`user_email`	string	✖	email 주소. 예시: `sample@sample.com` Email 주소가 있으면 값을 넣어줘야 합니다. 이 값이 없는 경우 리뷰 이메일이 발송되지 않습니다.
`allow_email`	integer	✔	email 수신 여부. 수신 허용 시 `1`, 수신 거부 시 `0`
`user_grade_id`	integer	✖	회원등급 ID. 회원 등급이 있으면 값을 넣어줘야 합니다. 이 값이 없는 경우 리뷰 게시판에 회원등급이 노출되지 않습니다.
`last_logged_in_at`	datetime(ISO 8601)	✖	마지막 로그인 날짜. 초단위까지만 유효
`active`	boolean	✖	활성회원 여부. 활성회원이면 `1`, 휴면/삭제회원이면 `0`
`birth_date`	date	✖	생년월일. `YYYY-mm-dd`
`user_status`	integer	✖	회원 상태. 일반회원 `10`, 휴면회원 `20`, 탈퇴회원 `30` 휴면회원(`20`)으로 변경 시 해당 회원의 리뷰가 숨김 처리되며, 탈퇴회원(`30`)으로 변경 시 해당 회원의 리뷰가 삭제됩니다.

Response

HTTP/1.1 201 Created
Location: https://api.cre.ma/v1/users

{
  "id": 1,
  "user_id": "kildong",
  "user_name": "홍길동",
  "allow_sms": false,
  "user_phone": "01012345678",
  "allow_email": false,
  "user_email": "sample@sample.com",
  "user_status": 10,
  "user_grade_id": 2,
  "last_logged_in_at": "2015-04-17T16:03:05.000+09:00",
  "active": true,
  "birth_date": "2000-01-01",
  "joined_at": "2015-04-17T16:03:05.000+09:00",
  "created_at": "2015-04-17T16:03:05.000+09:00",
  "updated_at": "2015-04-17T16:03:05.000+09:00"
}

Update a user

회원의 정보를 수정합니다.

with `id`

PATCH /v1/users/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	회원의 크리마 `id`
`user_id`	string	✖	회원의 쇼핑몰 아이디. 다른 회원과 중복되면 안됩니다.
`user_name`	string	✖	이름
`created_at`	datetime(ISO 8601)	✖	가입일. 초단위까지만 유효. 타겟 서비스를 이용하는 경우 필수로 입력해야 합니다.
`user_phone`	string	✖	휴대폰 번호. 예시: `010-1234-5678`, `01012345678`
`allow_sms`	integer	✖	SMS 문자 수신 여부. 수신 허용 시 `1`, 수신 거부 시 `0`
`user_email`	string	✖	email 주소. 예시: `sample@sample.com`
`allow_email`	integer	✖	email 수신 여부. 수신 허용 시 `1`, 수신 거부 시 `0`
`user_grade_id`	integer	✖	회원등급 `id`
`last_logged_in_at`	datetime(ISO 8601)	✖	마지막 로그인 날짜. 초단위까지만 유효
`active`	boolean	✖	활성회원 여부. 활성회원이면 `1`, 휴면/삭제회원이면 `0`
`birth_date`	date	✖	생년월일. `YYYY-mm-dd`
`user_status`	integer	✖	회원 상태. 일반회원 `10`, 휴면회원 `20`, 탈퇴회원 `30` 휴면회원(`20`)으로 변경 시 해당 회원의 리뷰가 숨김 처리되며, 탈퇴회원(`30`)으로 변경 시 해당 회원의 리뷰가 삭제됩니다.

with `user_id`

PATCH /v1/users HTTP/1.1

이름	타입	필수	설명
`user_id`	string	✔	회원의 쇼핑몰 아이디
`user_name`	string	✖	이름
`created_at`	datetime(ISO 8601)	✖	가입일. 초단위까지만 유효. 타겟 서비스를 이용하는 경우 필수로 입력해야 합니다.
`user_phone`	string	✖	휴대폰 번호. 예시: `010-1234-5678`, `01012345678`
`allow_sms`	integer	✖	SMS 문자 수신 여부. 수신 허용 시 `1`, 수신 거부 시 `0`
`user_email`	string	✖	email 주소. 예시: `sample@sample.com`
`allow_email`	integer	✖	email 수신 여부. 수신 허용 시 `1`, 수신 거부 시 `0`
`user_grade_id`	integer	✖	회원등급 `id`
`last_logged_in_at`	datetime(ISO 8601)	✖	마지막 로그인 날짜. 초단위까지만 유효
`active`	boolean	✖	활성회원 여부. 활성회원이면 `1`, 휴면/삭제회원이면 `0`
`birth_date`	date	✖	생년월일. `YYYY-mm-dd`
`user_status`	integer	✖	회원 상태. 일반회원 `10`, 휴면회원 `20`, 탈퇴회원 `30` 휴면회원(`20`)으로 변경 시 해당 회원의 리뷰가 숨김 처리되며, 탈퇴회원(`30`)으로 변경 시 해당 회원의 리뷰가 삭제됩니다.

Response

HTTP/1.1 204 No Content
Location: https://api.cre.ma/v1/users/:id

Delete a single user

회원 하나를 삭제합니다.

with `id`

DELETE /v1/users/:id HTTP/1.1

이름	타입	필수	설명
`id`	integer	✔	회원의 `id`

with `username`

DELETE /v1/users HTTP/1.1

이름	타입	필수	설명
`username`	string	✔	회원의 쇼핑몰 아이디

Response

HTTP/1.1 204 No Content

직접 사용해 보세요!

API Explorer를 사용하여 API 요청 및 응답을 확인해 보세요.

회원 목록
회원 정보
회원 생성
회원 업데이트
회원 삭제

User API

List users

Parameters

Response

Get a single user

with id

with username

Response

Create or Update a user

Parameters

Response

Update a user

with id

with user_id

Response

Delete a single user

with id

with username

Response

직접 사용해 보세요!

결과

with `id`

with `username`

with `id`

with `user_id`

with `id`

with `username`