๐Ÿ“„
Pic-Origin Documentation
  • ๐Ÿ“„Documentation
  • ๐Ÿ“„ํ™˜๊ฒฝ ๊ตฌ์„ฑ
  • Reference
    • ๐Ÿ“„API Reference
      • V1
        • Global
        • Platform
          • Platform
          • User
          • Image
        • User
          • User
          • Image
          • Filedata
          • Folder
          • Memo
          • Custom
      • V2
        • Platform
          • Platform
        • User
          • Image
  • read me
    • ๐Ÿ“„DetailedDocs
    • ๐Ÿ“„ChangeLog
  • ErrorCode
    • ๐Ÿ“„ERRORCODE
Powered by GitBook
On this page
  • ํŠน์ • ์œ ์ €์˜ ํด๋”๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.
  • ํŠน์ • ์œ ์ €์˜ ๋ชจ๋“  ํด๋”๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.
  • ํŠน์ • ์œ ์ €์˜ ํŠน์ • ํด๋”๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.
  • ํŠน์ • ์œ ์ €์˜ ํŠน์ • ํด๋”๋ฅผ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.
  • ํŠน์ • ์œ ์ €์˜ ํŠน์ • ํด๋”๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.
  1. Reference
  2. API Reference
  3. V1
  4. User

Folder

ํŠน์ • ์œ ์ €์˜ ํด๋”๋ฅผ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.

POST https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders

Path Parameters

Name
Type
Description

user_id*

String

์œ ์ €์˜ id

ex)8BfE96V8Xc

Headers

Name
Type
Description

Authorization*

String

User ${Token}

Request Body

Name
Type
Description

title*

String

ํด๋”์˜ ์ œ๋ชฉ(default=None)

ex)๊ฐ•๋‚จ๊ตฌ

parent_id

String

ํ•ด๋‹น ํด๋”์˜ ์ƒ์œ„ ํด๋”์˜ id(default=None)

ex)JC4Ub4EZo7

{
    "status_code": 200,
    "message": "์„ฑ๊ณต",
    "result": {
        "id": "4tb42KfHHB",
        "user_id": "EabHTVpYYm",
        "title": "test_biz",
        "parent_id": null,
        "created_at": "20240110_150924",
        "updated_at": "20240110_150924",
        "delete_at": null
    }
}

curl --location --request POST 'https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders' \
--header 'Authorization: User {YOUR_TOKEN}' \
--form 'title="{YOUR_TITLE}"' \
--form 'parent_id="{YOUR_PARENT_ID}"'

ํŠน์ • ์œ ์ €์˜ ๋ชจ๋“  ํด๋”๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.

GET https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders

Path Parameters

Name
Type
Description

user_id*

String

์œ ์ €์˜ id

ex)8BfE96V8Xc

Query Parameters

Name
Type
Description

has_delete_at

Bool

ํœด์ง€ํ†ต ์—ฌ๋ถ€(default=None)

ex)True

Headers

Name
Type
Description

Authorization*

String

User ${Token}

{
    "status_code": 200,
    "message": "์„ฑ๊ณต",
    "result": [
        {
            "id": "KumR7WKAUA",
            "user_id": "EabHTVpYYm",
            "title": "logun1",
            "parent_id": null,
            "created_at": "20240103_133924",
            "updated_at": "20240103_133924",
            "delete_at": null,
            "child_folders": []
        },
        {
            "id": "HxiGzpvV6m",
            "user_id": "EabHTVpYYm",
            "title": "test_biz1",
            "parent_id": null,
            "created_at": "20240117_230920",
            "updated_at": "20240214_145446",
            "delete_at": null,
            "child_folders": [
                {
                    "id": "JC4Ub4EZo7",
                    "user_id": "EabHTVpYYm",
                    "title": "logun2",
                    "parent_id": "HxiGzpvV6m",
                    "created_at": "20231019_132322",
                    "updated_at": "20231019_132322",
                    "delete_at": null,
                    "child_folders": [
                        {
                            "id": "HiBLQb9TyC",
                            "user_id": "EabHTVpYYm",
                            "title": "๋งน๋ณด๊ด€",
                            "parent_id": "JC4Ub4EZo7",
                            "created_at": "20231024_150645",
                            "updated_at": "20240221_144449",
                            "delete_at": null,
                            "child_folders": []
                        }
                    ]
                },
                {
                    "id": "4tb42KfHHB",
                    "user_id": "EabHTVpYYm",
                    "title": "test_biz",
                    "parent_id": "HxiGzpvV6m",
                    "created_at": "20240110_150924",
                    "updated_at": "20240110_150924",
                    "delete_at": null,
                    "child_folders": []
                }
            ]
        },
        {
            "id": "Aqtfi55uqc",
            "user_id": "EabHTVpYYm",
            "title": "test_biz4",
            "parent_id": null,
            "created_at": "20231024_153016",
            "updated_at": "20240214_151243",
            "delete_at": null,
            "child_folders": []
        }
    ]
}

curl --location --request GET 'https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders' \
--header 'Authorization: User {YOUR_TOKEN}' 

ํŠน์ • ์œ ์ €์˜ ํŠน์ • ํด๋”๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.

GET https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}

Path Parameters

Name
Type
Description

user_id*

String

์œ ์ €์˜ id

ex)8BfE96V8Xc

folder_id*

String

ํ•ด๋‹น ํด๋”์˜ id

ex)JC4Ub4EZo7

Query Parameters

Name
Type
Description

sort_by

String

์ •๋ ฌ ๊ธฐ์ค€(default=created_at)[created_at, updated_at,name]

ex)created_at

sort_order

String

์ •๋ ฌ ๋ฐฉ์‹(default=asc)[asc, desc]

ex)desc

get_image

Bool

์ด๋ฏธ์ง€ ํฌํ•จ ์—ฌ๋ถ€(default=True)

ex)True

last_index

Int

ํŽ˜์ด์ง€ ์‹œ์ž‘ ์ธ๋ฑ์Šค (default=None)

ex) 10

page_size

Int

ํ•œ ํŽ˜์ด์ง€ ๋‹น ํฌ๊ธฐ(default=60)

ex)60

with_history

Bool

์ด๋ฏธ์ง€์ˆ˜์ • ๋‚ด์—ญ ๊ณต๊ฐœ ์—ฌ๋ถ€(default=False)

ex)True

has_delete_at

Bool

ํœด์ง€ํ†ต ์—ฌ๋ถ€(default=None)

ex)True

with_custom

Bool

์ด๋ฏธ์ง€ ์ปค์Šคํ…€ ๊ณต๊ฐœ ์—ฌ๋ถ€ (default=None)

ex) True

with_memo

Bool

์ด๋ฏธ์ง€ ๋ฉ”๋ชจ ๊ณต๊ฐœ ์—ฌ๋ถ€ (default=None)

ex) True

Headers

Name
Type
Description

Authorization*

String

User ${Token}

{
    "status_code": 200,
    "message": "์„ฑ๊ณต",
    "result": {
        "count": 2,
        "total_count": 32,
        "last_index": 32,
        "page_size": 100,
        "total_filesize_mb": 0.12,
        "current_path": "/",
        "current_path_id": "/",
        "items": [
            {
                "is_folder": false,
                "data": {
                    "id": "de8c49f1-b153-49eb-8ecd-38b8957b4070",
                    "user_id": "EabHTVpYYm",
                    "folder_id": null,
                    "filename": "20231221_170923_5bcd01602b62b5256e1da8b248d631de_V00.JPEG",
                    "path_url": "https://pillo-app-dev.s3.amazonaws.com/EabHTVpYYm/images/edit/20231221_170923_5bcd01602b62b5256e1da8b248d631de_V00.JPEG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZEHAPJW7UBG2TATL%2F20240327%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Date=20240327T044247Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=dc68cc5ac8af6c8ba404cecdf46b5155e1258b19c07f7f42d080daccfaa65a49",
                    "org_path_url": "https://pillo-app-dev.s3.amazonaws.com/EabHTVpYYm/images/edit/20231221_170923_5bcd01602b62b5256e1da8b248d631de_V00.JPEG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZEHAPJW7UBG2TATL%2F20240327%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Date=20240327T044247Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=dc68cc5ac8af6c8ba404cecdf46b5155e1258b19c07f7f42d080daccfaa65a49",
                    "lat": 127.1052133,
                    "lng": 37.3595316,
                    "address_road": "๊ฒฝ๊ธฐ ์„ฑ๋‚จ์‹œ ๋ถ„๋‹น๊ตฌ ๋ถˆ์ •๋กœ 6",
                    "address_land": "๊ฒฝ๊ธฐ ์„ฑ๋‚จ์‹œ ๋ถ„๋‹น๊ตฌ ์ •์ž๋™ 178 - 1",
                    "address_land_number": "0-0",
                    "building_name": "NAVER๊ทธ๋ฆฐํŒฉํ† ๋ฆฌ",
                    "address_sort": null,
                    "address_det": "d",
                    "created_at": "20231221_170923",
                    "updated_at": "20231221_170923",
                    "delete_at": null,
                    "filedata_total": 1,
                    "is_signed": true,
                    "is_shared": false,
                    "has_det": null,
                    "image_resource_type": "JPEG",
                    "resolution": null,
                    "image_filesize_mb": 0.04,
                    "memos": [],
                    "customs": [],
                    "filedatas": []
                }
            },
            {
                "is_folder": false,
                "data": {
                    "id": "9af1afa3-e710-4858-b18b-de81559a9571",
                    "user_id": "EabHTVpYYm",
                    "folder_id": null,
                    "filename": "20231221_173159_5bcd01602b62b5256e1da8b248d631de_V00.JPEG",
                    "path_url": "https://pillo-app-dev.s3.amazonaws.com/EabHTVpYYm/images/edit/20231221_173159_4b37f9c3b4066dc76e55de0a3750911a_V25.JPEG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZEHAPJW7UBG2TATL%2F20240327%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Date=20240327T044247Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=79dccf6a2db0852c5627949efc9c0491aba29cd2fc325653805ca2c0fb657d7f",
                    "org_path_url": "https://pillo-app-dev.s3.amazonaws.com/EabHTVpYYm/images/edit/20231221_173159_5bcd01602b62b5256e1da8b248d631de_V00.JPEG?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAZEHAPJW7UBG2TATL%2F20240327%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Date=20240327T044247Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=a73bca54d86a255f059f77893d81bc768636ac295b08c07c2bcacb148a876a4d",
                    "lat": 37.3595316,
                    "lng": 127.1052133,
                    "address_road": "๊ฒฝ๊ธฐ ์„ฑ๋‚จ์‹œ ๋ถ„๋‹น๊ตฌ ๋ถˆ์ •๋กœ 6",
                    "address_land": "๊ฒฝ๊ธฐ ์„ฑ๋‚จ์‹œ ๋ถ„๋‹น๊ตฌ ์ •์ž๋™ 178 - 1",
                    "address_land_number": "0-0",
                    "building_name": "NAVER๊ทธ๋ฆฐํŒฉํ† ๋ฆฌ",
                    "address_sort": null,
                    "address_det": "d",
                    "created_at": "20231221_173159",
                    "updated_at": "20240311_151113",
                    "delete_at": null,
                    "filedata_total": 26,
                    "is_signed": true,
                    "is_shared": false,
                    "has_det": null,
                    "image_resource_type": "JPEG",
                    "resolution": "576x1024",
                    "image_filesize_mb": 0.08,
                    "memos": [],
                    "customs": [],
                    "filedatas": []
                }
            }
        ]
    }
}

curl --location --request GET 'https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}' \
--header 'Authorization: User {YOUR_TOKEN}' 

ํŠน์ • ์œ ์ €์˜ ํŠน์ • ํด๋”๋ฅผ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.

PUT https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}

Path Parameters

Name
Type
Description

user_id*

String

์œ ์ €์˜ id

ex)8BfE96V8Xc

folder_id*

String

ํ•ด๋‹น ํด๋”์˜ id

ex)JC4Ub4EZo7

Query Parameters

Name
Type
Description

delete

String

ํด๋” ์‚ญ์ œ ์—ฌ๋ถ€ (๋Œ€์†Œ๋ฌธ์ž ๊ตฌ๋ถ„ ์—†์ด 'true' or 'false') (default=None)

ex)True

Headers

Name
Type
Description

Authorization*

String

User ${Token}

Request Body

Name
Type
Description

parent_id

String

์ƒ์œ„ ํด๋”์˜ id(default="UNSET")

ex)JC4Ub4EZo7

title

String

ํด๋”์˜ ์ œ๋ชฉ(default=None)

ex)๊ฐ•๋‚จ๊ตฌ

{
    "status_code": 200,
    "message": "์„ฑ๊ณต",
    "result": {
        "id": "HiBLQb9TyC",
        "user_id": "EabHTVpYYm",
        "title": "๊ฐ•๋‚จ๊ตฌ",
        "parent_id": null,
        "created_at": "20231024_150645",
        "updated_at": "20231024_150645",
        "delete_at": "20240209_151705"
    }
}

curl --location --request PUT 'https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}' \
--header 'Authorization: User {YOUR_TOKEN}' \
--form 'parent_id={PARENT_ID}'

ํŠน์ • ์œ ์ €์˜ ํŠน์ • ํด๋”๋ฅผ ์‚ญ์ œํ•ฉ๋‹ˆ๋‹ค.

DELETE https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}

Path Parameters

Name
Type
Description

user_id*

String

์œ ์ €์˜ id

ex)8BfE96V8Xc

folder_id*

String

ํ•ด๋‹น ํด๋”์˜ id

ex)JC4Ub4EZo7

Headers

Name
Type
Description

Authorization*

String

User ${Token}

{
  "status_code": 200,
  "message": "์„ฑ๊ณต",
  "result": {
    "deleted_folders": [
      "FJiqmSDY5j",
      "GbBkh7cB6u"
    ],
    "deleted_images": []
  }
}

curl --location --request DELETE 'https://service-stage.pic-origin.com/api/v1/users/{user_id}/folders/{folder_id}'' \
--header 'Authorization: User {YOUR_TOKEN}'
PreviousFiledataNextMemo

Last updated 1 year ago

๐Ÿ“„