Documentation Powered by ReDoc

Face AiDee API (1.0.0)

Download OpenAPI specification:Download

API KEY 발급

Request Body schema: application/json
username
string
password
string

Responses

201

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

API KEY 발급이 제한된 계정

500

서버 측 처리 에러

post /api/v1/auth/key
/api/v1/auth/key

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "username": "test",
  • "password": "$123$abadfo124393eo"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "00000000-0000-0000-0000-000000000000",
  • "secret": "6E686506B4B2516CDFBC"
}

API Token 발급

Request Body schema: application/json
key
string <uuid>
secret
string

Responses

201

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

500

서버 측 처리 에러

post /api/v1/auth/token
/api/v1/auth/token

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "key": "00000000-0000-0000-0000-000000000000",
  • "secret": "6E686506B4B2516CDFBC"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 200,
  • "expire": "2050-01-01T00:00:00+09:00",
  • "token": "header.payload.hash"
}

API Token 갱신

header Parameters
X-API-Token
required
string

인증 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

500

서버 측 처리 에러

patch /api/v1/auth/token
/api/v1/auth/token

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 200,
  • "expire": "2050-01-01T00:00:00+09:00",
  • "token": "header.payload.hash"
}

API Token 삭제

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

500

서버 측 처리 에러

delete /api/v1/auth/token
/api/v1/auth/token

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 200
}

프로젝트 조회

header Parameters
X-API-Token
required
string

API 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

500

서버 측 처리 에러

get /api/v1/projects
/api/v1/projects

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

유저 생성

path Parameters
project_id
required
integer

프로젝트 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Request Body schema: application/json
group_id
integer
registrant
string
status
string
properties
object

Responses

201

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

post /api/v1/projects/{project_id}/users
/api/v1/projects/{project_id}/users

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group_id": 1,
  • "registrant": "USER",
  • "status": "UNAPPROVED",
  • "properties":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 1,
  • "created_at": "2020-01-01T12:00:00.000000000+09:00"
}

유저 수정

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Request Body schema: application/json
group_id
integer
registrant
string
properties
object

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

patch /api/v1/projects/{project_id}/users/{user_id}
/api/v1/projects/{project_id}/users/{user_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "group_id": 1,
  • "registrant": "USER",
  • "properties":
    {
    }
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 1,
  • "updated_at": "2020-01-01T12:00:00.000000000+09:00"
}

유저 삭제

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

delete /api/v1/projects/{project_id}/users/{user_id}
/api/v1/projects/{project_id}/users/{user_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 1,
  • "deleted_at": "2020-01-01T12:00:00.000000000+09:00"
}

대상의 모든 얼굴 조회

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

500

서버 측 처리 에러

get /api/v1/projects/{project_id}/users/{user_id}/faces
/api/v1/projects/{project_id}/users/{user_id}/faces

Response samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    },
  • {
    }
]

대상의 모든 얼굴 삭제

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

500

서버 측 처리 에러

delete /api/v1/projects/{project_id}/users/{user_id}/faces
/api/v1/projects/{project_id}/users/{user_id}/faces

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "user_id": 1,
  • "deleted_at": "2020-01-01T12:00:00.000000000+09:00"
}

얼굴 생성

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Request Body schema: application/json
save_image
boolean
image
string <base64>

Responses

201

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

post /api/v1/projects/{project_id}/users/{user_id}/faces
/api/v1/projects/{project_id}/users/{user_id}/faces

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "save_image": true,
  • "image": "<BASE64_ENCODED_IMAGE>"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 4,
  • "created_at": "2020-01-01T12:00:00.000000000+09:00"
}

얼굴 조회

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

face_id
required
integer

얼굴 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저 혹은 얼굴을 찾을 수 없음

500

서버 측 처리 에러

get /api/v1/projects/{project_id}/users/{user_id}/faces/{face_id}
/api/v1/projects/{project_id}/users/{user_id}/faces/{face_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 1,
  • "image": "<BASE64_ENCODED_IMAGE>",
  • "created_at": "2020-01-01T12:00:00.000000000+09:00"
}

얼굴 수정

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

face_id
required
integer

얼굴 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Request Body schema: application/json
save_image
boolean
image
string <base64>

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저 혹은 얼굴을 찾을 수 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

patch /api/v1/projects/{project_id}/users/{user_id}/faces/{face_id}
/api/v1/projects/{project_id}/users/{user_id}/faces/{face_id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "save_image": true,
  • "image": "<BASE64_ENCODED_IMAGE>"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 1,
  • "updated_at": "2020-01-01T12:00:00.000000000+09:00"
}

얼굴 삭제

path Parameters
project_id
required
integer

프로젝트 식별자

user_id
required
integer

유저 식별자

face_id
required
integer

얼굴 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저 혹은 얼굴을 찾을 수 없음

500

서버 측 처리 에러

delete /api/v1/projects/{project_id}/users/{user_id}/faces/{face_id}
/api/v1/projects/{project_id}/users/{user_id}/faces/{face_id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "id": 1,
  • "deleted_at": "2020-01-01T12:00:00.000000000+09:00"
}

얼굴 체크인

path Parameters
project_id
required
integer

프로젝트 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Request Body schema: application/json
condition
object
option
integer
image
string <base64>

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

post /api/v1/projects/{project_id}/check-in
/api/v1/projects/{project_id}/check-in

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "condition":
    {
    },
  • "option": 3,
  • "image": "<BASE64_ENCODED_IMAGE>"
}

Response samples

Content type
application/json
Example
success
Copy
 Expand all Collapse all
{
  • "user_id": 4,
  • "status": "APPROVED",
  • "similarity": 90.3,
  • "checkin_at": "2020-01-01T12:00:00.000000000+09:00"
}

얼굴 탐색

path Parameters
project_id
required
integer

프로젝트 식별자

header Parameters
X-API-Token
required
string

인증 토큰

Request Body schema: application/json
condition
object
image
string <base64>

Responses

200

올바른 요청 처리

400

잘못된 입력 값

401

허가 되지 않은 인증 정보

403

해당 프로젝트에 대한 권한이 없음

404

등록된 유저를 찾을 수 없음

409

올바른 입력이지만 조건에 부합하지 않음.

500

서버 측 처리 에러

post /api/v1/projects/{project_id}/_search
/api/v1/projects/{project_id}/_search

Request samples

Content type
application/json
Example
requestByUserId
Copy
 Expand all Collapse all
{
  • "condition":
    {
    },
  • "image": "<BASE64_ENCODED_IMAGE>"
}

Response samples

Content type
application/json
Example
success
Copy
 Expand all Collapse all
{
  • "user_id": 4,
  • "matched": true,
  • "similarity": 90.3,
  • "searched_at": "2020-01-01T12:00:00.000000000+09:00"
}