공유스토리지_API NAS

API NAS API 사용 방법(Key 관리 포함)

관리콘솔 에서  API NAS  관리페이지 접속이 가능합니다. 

 

서비스 경로 

관리콘솔(console.iwinv.kr) -스토리지 - 공유 스토리지 - 스토리지 관리 

바로가기 : http://console.iwinv.kr/na 

 

 

 

1.관리콘솔 - 스토리지 - 공유스토리지 - 스토리지 관리 페이지에서  상세정보 - 관리페이지 접속 을 클릭합니다. 

 

2. 아이디 (서브도메인) 과 비밀번호를 입력하여 로그인합니다. 

 

3.  로그인하면 API NAS  관리 페이지 확인 가능합니다. 

Key 관리 

  

API NAS  관리 페이지  - 설정관리 에서  Key 확인, 관리가 가능합니다. 

*AccessKey 생성 버튼으로 새 AccessKey 생성이 가능합니다. 

AccessKey 삭제는 사용여부 를 중지로 변경 후, 삭제 가능합니다.  

 

 

 

API History

 

API NAS - API History 에서 히스토리 조회 가능합니다. 

개발자 API  

 

♦API 개요  

Token 생성 

  API   HTTP Method   설명
Authorization GET AccessKey를 통하여 Token을 생성

 업로드

  API   HTTP Method   설명
Files upload POST 파일 업로드

 폴더관리 

  API   HTTP Method   설명
Folder create POST 폴더 생성
Folder list select GET 폴더 리스트 조회
Folder detail select GET 폴더 상세정보 조회

파일 관리

  API   HTTP Method   설명
Files list select GET 파일 리스트 조회
Files detail select GET 파일 상세정보 조회
Files delete DELETE 파일 멀티 삭제
Files name update PUT 파일명 수정
Files tag update PUT 파일 태그 수정

 

 

♦Authorization

 

개요

API를 실행하기 위해 Token을 생성합니다.Token은 모두 API에 필수로 적용하여야 합니다.

HTTP Method & URL

GET

 https://cifstest.na.iwinv.net/api/v1/authorization/

Request Parameter

  명칭   타입   필수여부   설명
AccesskeyID String Yes Accesskey ID
AccesskeySecret String Yes Accesskey pw

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Token String 인증토큰
Result String API요청결과

주의 사항 :

- Accesskey는 [콘솔>설정>Accesskey생성]에서 생성하여 사용합니다.

- AccesskeyID와 AccesskeySecret를 Header에 대입하여 호출하도록 합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/authorization/

Response 예시

JSON 형식

{

"RequestID" : "12", 

"Token" :"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJleHAiOjE1NjE2ODU1NTksImNsaWVudElQIjoiMTkyLjE2OC4wLjE3IiwidXNlckxvY2FsSVAiOiIiLCJhY2Nlc3NrZXkiOiIxbXJ3NXE1WU16d0lVRVpuWGRHOE5hNjhaVE41YTY2NVdPdjhGUkdHaDcifQ.52cDdvyh2KIx0emYwEgJlDPeakDmoX1f7wDsa-kC3_GtcV6_44efdq4ahXMwCUI2DIvB4MS8mZDGwXERqZ2fQA",

"Result" : "Token create success"

}

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Invalid accesskey 403 사용할 수 없는 accesskey 입니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Unavailable token create 503 토큰 생성에 실패하였습니다. 관리자에게 문의해주시기 바랍니다.

 

 

 

♦Files upload

 

개요

Token을 이용하여 파일를 업로드를 실행합니다. multipart/form data를 이용한 업로드 방식입니다.

HTTP Method & URL

 POST 

 https://cifstest.na.iwinv.net/api/v1/files/{folderKey}

Request Parameter

  명칭   타입   필수여부   설명
token String Yes 인증토큰
folderKey String Yes 폴더키
files file Yes 파일
tag String No 태그

- files는 아래 이미지를 참조하여 사용하시기 바랍니다.

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Files Array 파일 목록
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/files/code****7g4sN2z134

Response 예시

JSON 형식

{

      "RequestID" : "84",

      "Files" : [

                {filesKey: "code****wQnm4taIl16089e7H43Af", "filesName": "test1.JPG"},

                {filesKey: "code****6Ys1Qpk0noavEdp8597Ka4", filesName: "test2.mp4"},

                {filesKey: "code****5Gp6O14Z698i9hq7JxDA4", filesName: "test3.pdf"}

               ],

      "Result" : "3 of 3 files uploaded"

}

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Not enough storage 400 스토리지 용량이 부족합니다.
Exceeded files 400 멀티 업로드 시 최대 {$count}개 까지 가능합니다.
Exceeded files size 400 단일 파일 용량은 최대 {$size}개 까지 업로드 가능합니다.
Exceeded filesName 400 filesName은 최대 255글자 이내로 입력되어야 합니다.
Invalid filesName 400 . .. 또는 / 포함일 경우 허용되지 않습니다.
Invaild tag name 400 태그는 10개까지 생성 할 수 있고 최대 15자 까지 가능합니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Folder not found 404 없는 폴더입니다.
Unavailable member storage 403 사용할 수 없는 스토리지입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Unavailable files upload 503 업로드 중에 문제가 발생 하였습니다. 관리자에게 문의해주시기 바랍니다.
Path not found 503 파일 경로 검색시 오류가 발생하였습니다.관리자에게 문의해주시기 바랍니다.

 

 

♦Folder create 

 

개요

파일함(스토리지)의 지정된 경로에 신규 폴더를 생성합니다.

HTTP Method & URL

 POST 

 https://cifstest.na.iwinv.net/api/v1/folders/{folderKey}

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
folderKey String Yes 폴더키 ( 상위 폴더 )
folderName String Yes 폴더명

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
FolderKey String 폴더키
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시
Request 예시
https://cifstest.na.iwinv.net/api/v1/folders/code****aARRaFm2Bz9F7
Response 예시
JSON 형식

{
	"RequestID" : "48",
	"FolderKey" : "code****0HjE3y0DzD3kqdi7",
	"Result" : "Folder create success"
}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Required folderKey 400 folderKey는 필수 항목입니다.
Required folderName 400 folderName은 필수 항목입니다.
Not authorized 403 권한이 없습니다.
Duplicated folderName 403 이미 존재하는 폴더명입니다.
Exceeded folderName 403 folderName은 최대 255글자 이내로 입력되어야 합니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Folder not found 404 없는 폴더입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Unavailable folder create 503 폴더 생성중에 문제가 발생하였습니다. 관리자에게 문의해주시기 바랍니다.

 

 

♦Folder list select

 

개요

지정한 경로의 폴더 목록을 조회합니다.

HTTP Method & URL

 GET 

 https://cifstest.na.iwinv.net/api/v1/folders/{folderKey}?action=list

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
folderKey String Yes 폴더키 ( 상위 폴더 )
action String Yes 요청분류 ( 목록요청 : list )

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Folders Array 폴더 목록
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시
Request 예시
https://cifstest.na.iwinv.net/api/v1/folders/code****aARRaFm2Bz9F7
Response 예시
JSON 형식

{
	"RequestID" : "33",
	"Folders": [
		{
			"folder_key": "code****t4GylCFvG0I6unf91E6bF2n1",
			"name": "folder1",
			"date_insert": "2019-00-00 00:00:00"
		},
		{
			"folder_key": "code****b2pHdxgKYk9LQUDE4nyI25V2I7",
			"name": "folder2",
			"date_insert": "2019-00-00 00:00:00"
		},
		{
			"folder_key": "code****19OJZORgEdq95x8y4uE5r5",
			"name": "folder3",
			"date_insert": "2019-00-00 00:00:00"
		},
	],
	"Result" : "Folders select success"
}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400                      토큰이 만료 되었습니다.
Required folderKey 400 folderKey는 필수 항목입니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Folder not found 404 없는 폴더입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.

 

 

♦Folder detail select

 

개요

지정한 경로의 특정 폴더 상세 정보를 조회합니다.

HTTP Method & URL

 GET 

 https://cifstest.na.iwinv.net/api/v1/folders/{folderKey}

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
folderKey String Yes 폴더키

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Folders Array 폴더 상세 정보
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

 

예시
Request 예시
https://cifstest.na.iwinv.net/api/v1/folders/code****aARRaFm2Bz9F7
Response 예시

JSON 형식

{
	"RequestID" : "78",
	"Folders": [
		{
			"folder_key": "code****t4GylCFvG0I6unf91E6bF2n1",
			"name": "folder1",
			"date_insert": "2019-00-00 00:00:00"
		},
	],
	"Result" : "Folder select success"
}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Required folderKey 400 folderKey는 필수 항목입니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Folder not found 404 없는 폴더입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.

 

 

♦File list select

 

개요

지정한 경로의 파일 목록을 조회합니다.

 

HTTP Method & URL

 GET 

 https://cifstest.na.iwinv.net/api/v1/files/{folderKey}?keyType=list

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
folderKey String Yes 폴더키
keyType String Yes 요청분류 ( 목록요청 : list )

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
files Array 파일 목록
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/files/code****aARRaFm2Bz9F7?keyType=list

Response 예시

JSON 형식

{
          "RequestID" : "51",
          "Files": {
                 "code****F07B0nxayp94JsXSLtvV8ln2u9": {
                 "name": "file1.png",
                 "size": "810.92 KB",
                 "tag": null,
                 "date_insert": "2019-00-00 00:00:00"
},
          "code****Cyt4PVv9wtEZr3Li4K75dNF9": {
                 "name": "video.mp4",
                 "size": "2.93 GB",
                 "tag": null,
                 "date_insert": "2019-00-00 00:00:00"
           },
          "code****6O14Z698i9hq7JxDA4p4": {
                 "name": "document.zip",
                 "size": "44.26 MB",
                 "tag": "origenal,free",
                 "date_insert": "2019-00-00 00:00:00"
           },
     },
"Result" : "Files select success"
}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Required keyType 400 keyType은 필수 항목입니다.
Required folderKey 400 folderKey는 필수 항목입니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Folder not found 404 없는 폴더입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Path not found 503 파일 경로 검색시 오류가 발생하였습니다. 관리자에게 문의해주시기 바랍니다.

 

 

♦File detail select 

 

개요

특정 파일 상세 정보를 조회합니다.

 

HTTP Method & URL

 GET 

 https://cifstest.na.iwinv.net/api/v1/files/{filesKey}?keyType=single

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
filesKey String Yes 파일 키
keyType String Yes 요청분류 ( 상세요청 : single )

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
files Array 파일 상세 정보
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/files/code****aARRaFm2Bz9F7?keyType=single

Response 예시

 

JSON 형식 

{
          "RequestID" : "323",
          "Files": {
                 "file_key": "code****A8bVanI7Q9713",  
                 "name": "img.jpg",
                 "size": "44.26 KB",
                 "tag": "origenal,free",
                 "date_insert": "2019-00-00 00:00:00"
          },
         "Result" : "Files select success"
}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Required keyType 400 keyType은 필수 항목입니다.
Required filesKey 400 filesKey는 필수 항목입니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Files not found 404 없는 파일입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.

 

 

♦Files delete

 

개요

파일를 삭제합니다.멀티삭제도 지원합니다.

HTTP Method & URL

  DELETE 

 https://cifstest.na.iwinv.net/api/v1/files/{filesKeys}

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
filesKeys Array Yes 파일 키

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

- filesKeys 를 json로 정려하고 보내야합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/files/["code****aARRaFm2Bz9F7","code****e1dcf84c8b45ca"]

Response 예시

JSON 형식

{

      "RequestID" : "27",

       "Result" : "2 of 2 files delete succes"

}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Required filesKey 400 filesKey는 필수 항목입니다.
filesKey type error 400 filesKey의 타입은 배열이어야 합니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Folder not found 404 없는 폴더입니다.
Files not found 404 없는 파일입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Unavailable files delete 503 파일 삭제에 실패하였습니다. 관리자에게 문의해주시기 바랍니다.
Path not found 503 파일 경로 검색시 오류가 발생하였습니다.관리자에게 문의해주시기 바랍니다.

 

 

♦Files name update

 

개요

특정 파일 이름을 수정합니다.

HTTP Method & URL

  DELETE 

 https://cifstest.na.iwinv.net/api/v1/files/{filesKey}?action=name&filesName={filesName}

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
filesKey String Yes 파일 키
action String Yes 요청분류 ( 파일명 : name )
filesName String Yes 파일명

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/files/code****aARRaFm2Bz9F7?action=name&filesName=newimg.jpg

Response 예시

JSON 형식

{
	"RequestID" : "72",
	"Result" : "Files name update success"
}

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Invalid filesName 400 filesName은 최대 255글자 이내로 입력되어야 합니다.
Invalid filesName 400 . .. 또는 / 포함일 경우 허용되지 않습니다.
Required filesKey 400 filesKey는 필수 항목입니다.
Required action 400 action은 필수 항목입니다.
Required filesName 400 filesName은 필수 항목입니다.
Duplicated filesName 400 이미 존재하는 filesName입니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Files not found 404 없는 파일입니다.
Unavailable storage 404 사용할 수 없는 스토리지입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Unavailable files name update 503 파일 이름 수정중에 문제가 발생하였습니다. 관리자에게 문의해주시기 바랍니다.

 

 

♦Files tag update

 

개요

특정 파일 태그를 수정합니다.

HTTP Method & URL

 DELETE 

 https://cifstest.na.iwinv.net/api/v1/files/{filesKey}?action=tag&tag={tag}

Request Parameter

  명칭   타입   필수여부   설명
Authorization String Yes 인증토큰
filesKey String Yes 파일 키
action String Yes 요청분류 ( 파일 태그 : tag )
tag String Yes 태그 내용

Response Parameter

  명칭   타입   설명
RequestID String API요청번호
Result String API요청결과

주의 사항 :

- API 호출시 Header의 Authorization 값에 생성한 Token을 필수로 입력합니다.

예시

Request 예시

https://cifstest.na.iwinv.net/api/v1/files/code****aARRaFm2Bz9F7?action=tag&tag=vip,500

Response 예시

JSON 형식

{

         "RequestID" : "95",

         "Result" : "Files tag update success"

}

 

Error 코드

현재 API에 대응되는 Error코드입니다.

  명칭   코드   메시지
Token not found 400 인증 토큰이 없습니다.
Expired token 400 토큰이 만료 되었습니다.
Required filesKey 400 filesKey는 필수 항목입니다.
Required action 400 action은 필수 항목입니다.
Invalid tag name 400 태그는 10개까지 생성 할 수 있고 최대 15자 까지 가능합니다.
Duplicated tag name 400 이미 존재하는 태그 이름입니다.
Not authorized 403 권한이 없습니다.
Unsupported HTTP method 403 지원하지 않는 HTTP method 입니다.
Unavailable member storage 403 사용할 수 있는 스토리지가 없습니다.
Files not found 404 없는 파일입니다.
Internal server error 500 일시적인 장애가 발생되고 있습니다. 관리자에게 문의해주시기 바랍니다.
Unavailable tag update 503 태그 수정 중에 문제가 발생하였습니다. 관리자에게 문의해주시기 바랍니다.