API 설명서

모든 API 요청은 REST-스타일 URL에 표준 HTTP 요청입니다. 응답은 JSON 또는 이미지 입니다 (결과를 가져올 때)

인증: API는 표준 HTTP 기본 액세스 인증을 이용합니다. API에 대한 모든 요구들은 사용자로 API Id 비밀번호로 API 키로 API Id와 함께 귀하의 API 자격 증명이 필요합니다. ClippingMagic.js는 귀하의 사용자에게 API 키를 알려주지 않기 위하여 귀하의 API Id만 사용함에 주의하십시오

보안: 모든 요구는 HTTPS에서 행하여야 하며, 모든 요구가 인증되어야 합니다. 성공적인 요구를 하려면 귀하의 HTTP 클라이언트 라이브러리는 서버 이름 표시 (SNI)를 지원하여야 합니다. 이상한 핸드셰이크 에러를 받으면, 대부분이 이러한 이유입니다.

시도해 보십시오

모든 API 행동은 귀하가 브라우저에서 즉시 시험할 수 있는 html 형태 / 링크 예와 함께 제공됩니다. cURL 예는 등록하였으면 귀하의 API 자격을 사용하며, 터미널에 단지 복사-붙여놓기를 하고 실행할 수 있습니다.

오류 JSON 개체

우리는 API 요청의 성공 또는 실패를 알려주기 위하여 기본 HTTP 상태를 이용하며 또한 반환된 오류 JSON 매체에 중요한 에러 정보를 포함합니다.

문제가 있는 요구에는 언제나 오류 JSON 개체를 반환하려고 합니다. 하지만, 내부 서버 실패가 비-JSON 오류 메시지로 나타나는 것은 항상 이론적으로 가능합니다.

특성

status디버깅에 도움이 되도록 응답의 HTTP 상태가 여기 다시 되풀이됩니다.
codeClipping Magic 내부 오류 코드
message디버깅에 유용한 사람이 읽을 수 있는 오류 메시지.

오류 응답 예

{
  "error" : {
    "status" : 400,
    "code" : 1006,
    "message" : "Failed to read the supplied image. "
  }
}

귀하 요구의 HTTP 상태가 200 이면, 오류 JSON 개체가 반환되지 않으며, 요구가 널리 전달되었다고 생각하여도 안전합니다.

일부 HTTP 클라이언트 라이브러리는 400 에서 599 범위로 HTTP 상태 예외를 알려줍니다. 이러한 예외를 감지하고 적절히 처리하여야 합니다.

HTTP Status의미
200-299

성공

301-303

결과를 다운로드할 때: 귀하는 실제 결과 저장 장소로 리디렉션됩니다. 오류 JSON 개체가 반환되지 않습니다. 결과를 다운로드할 때는 귀하의 HTTP 클라이언트 라이브러리를 리디렉션을 따르도록 구성하여야 합니다.

400-499

요구에서 제공된 정보에 문제가 있습니다 (예, 매개변수가 없음) 오류 메시지를 검토하고 어떻게 수정할 것인지 알아보십시오.

500-599

Clipping Magic-내부 오류가 있었습니다. 잠시 기다리신 다음 다시 시도하십시오, 그리고 문제가 계속되면 이메일을 저희한테 보내주십시오.

이미지 JSON 개체

이미지 기록이 JSON 개체로 균일한 방법으로 표현되며, 여러가지의 API 행동으로 반환됩니다.

특성

id

이미지를 위한 고유 식별자 사용자에게 편집을 하고 결과를 다운로드할 수 있다고 알려줄 필요가 있습니다.

secret

이 이미지를 ClippingMagic.js로 편집하는데는 필요한 비밀 키

resultRevision

다운로드할 수 있는 가장 최근 개정 번호를 의미하는 번호 (0 는 아직 사용할 수 있는 결과가 없음).

항상 귀하가 이전에 다운로드한 것보다 더 새로운 결과가 있는지 결정할 수 있게 합니다.

originalFilename

원본 이미지를 업로드할 때 파일이름을 포함하는 문자열

test

true는 이것이 자유로이 다운로드할 수 있는 시험 이미지이지만 결과에는 워터마크가 있습니다.

false는 이것이 처리하는데 크레딧이 필요한 생산 이미지이지만 결과에는 워터마크가 없습니다.

{
  "id" : 2345,
  "secret" : "image_secret",
  "resultRevision" : 0,
  "originalFilename" : "image.jpg",
  "test" : false
}

업로드 POST https://clippingmagic.com/api/v1/images

이미지를 업로드하기 위하여, 표준 HTTP POST 파일 업로드를 합니다. 컨텐츠 타입multipart/form-data이어야 하는 것을 명십하십시오

특성

image

업로드할 이미지. .bmp, .gif, .jpeg, .png 또는 .tiff 파일이어야 합니다.

최대 이미지 크기는 8,388,608픽셀이며, 4,194,404픽셀로 축소됩니다. 업로드하기 이전에 나중 숫자 또는 그 이하로 미리-축소하십시오.

선택적
test

이것이 시험 이미지임을 표시하기 위하여 'true'를 패스하십시오. 테스트 이미지들은 무료로 사용할 수 있으나, 그 결과에는 워터마크가 있습니다.

반응 특성

image

이미지 JSON 개체.

구독하지 않고 테스트 모드로 이미지를 업로드할 수 있습니다. 하지만, 업로드하는데 크레딧을 사용하지 않아도 되지만, API를 통하여 생산 이미지를 업로드하기 위하여 유효한 API 구독이 필요합니다.

시도해 보십시오

Username = API Id, Password = API Key

cURL

$ curl https://clippingmagic.com/api/v1/images \
 -u 123:[secret] \ 
 -F image=@example.jpg

'example.jpg'가 있다고 가정하십시오. 필요시 대치하십시오.

반응 예

{
  "image" : {
    "id" : 2345,
    "secret" : "image_secret",
    "resultRevision" : 0,
    "originalFilename" : "image.jpg",
    "test" : false
  }
}

다운로드 GET https://clippingmagic.com/api/v1/images/[image_id]

결과를 다운로드하기 위하여, 표준 HTTP GET을 합니다. 결과가 먼저 생성되어야 합니다. 전형적으로 이는 귀하가 귀하의 귀하의 최종 사용자에게 귀하의 사이트에서 ClippingMagic.js 를 사용하게 함으로 이루어집니다.

시험 결과는 자유로이 다운로드할 수 있으나, 워터마크가 있습니다. 생산 결과는 처음 다운로드하였을떄는 한 크레딧이 요구되며; 연속적 다운로드는 무료입니다.

결과가 있으면, 귀하는 그곳으로 리디렉션되므로 (결과는 Amazon S3에 저장됨), 귀하의 클라이언트 라이브러리가 리디렉션을 따르도록 구성되었는가 확인하십시오.

x-amz-meta-resultrevision 반응 헤더는 다운로드된 결과의 resultRevision를 의미하며 Content-Disposition 헤더는 다음 확장명을 포함하는 결과 파일이름을 의미합니다: 불투명한 배경이 있는 결과로 .jpeg, 투명한 배경이 있는 결과로 .png.

사용할 결과가 없으면, 오류 반응을 받습니다.

인수

image_id

URL에 포함됨

업로드 호출에서 반환된 id 값을 삽입하여야 합니다.

선택적
format

기본값으로 결과 이미지가 반환됩니다. 하지만, format=json를 지정하면, 이미지 JSON 개체를 대신 받습니다. resultRevision을 검사하기를 원하거나, 또는 이미지 비밀을 잃었을 때 유용합니다.

이미지 JSON 개체를 갖고 오는 데는 귀하의 계정에 청구되지 않습니다; 생산 결과를 다운로드할 때만 청구됩니다.

Username = API Id, Password = API Key

cURL

$ curl https://clippingmagic.com/api/v1/images/2345 \
 -u 123:[secret] \ 
 -LOJ

JSON 응답 예

{
  "image" : {
    "id" : 2345,
    "secret" : "image_secret",
    "resultRevision" : 0,
    "originalFilename" : "image.jpg",
    "test" : false
  }
}

목록 GET https://clippingmagic.com/api/v1/images

이미지 JSON 개체 목록을 갖고 오려면 표준 HTTP GET을 행합니다.

인수

선택적
limit

가져올 기록 숫자. 20로 기본값이 됨 (최소 1, 최대 100).

선택적
offset

기록 목록에서 사용할 오프셋 (기본값 0).

반응 특성

images

이미지 JSON 개체의 배열

limit

limit는 결과를 생산하는데 실제 사용됩니다.

offset

offset는 결과를 생산하는데 실제 사용됩니다.

Username = API Id, Password = API Key

cURL

$ curl "https://clippingmagic.com/api/v1/images?limit=2&offset=0" \
 -u 123:[secret]

반응 예

{
  "images" : [ {
    "id" : 2345,
    "secret" : "image_secret",
    "resultRevision" : 0,
    "originalFilename" : "image.jpg",
    "test" : false
  }, {
    "id" : 2346,
    "secret" : "image_secret2",
    "resultRevision" : 0,
    "originalFilename" : "image.jpg",
    "test" : false
  } ],
  "limit" : 2,
  "offset" : 0
}

제거 POST https://clippingmagic.com/api/v1/images/[image_id]/delete

이미지를 제거하기 위하여, delete-URL에 표준 HTTP POST를 합니다.

많은 HTTP 클라이언트 라이브러리가 HTTP DELETE 동사를 지원하지 않는 현실을 처리하는데 표준 REST 습관으로부터 약간 이탈된 것이며, 동시에 같은 결과를 내는데 많은 방법의 사용을 피합니다.

인수

image_id

URL에 포함됨

업로드 호출에서 반환된 id 값을 삽입하여야 합니다.

반응 특성

image

제거된 이미지 JSON 개체

시도해 보십시오

Username = API Id, Password = API Key

cURL

$ curl https://clippingmagic.com/api/v1/images/2345/delete \
 -u 123:[secret] \ 
 -X POST

반응 예

{
  "image" : {
    "id" : 2345,
    "secret" : "image_secret",
    "resultRevision" : 0,
    "originalFilename" : "image.jpg",
    "test" : false
  }
}

계정 GET https://clippingmagic.com/api/v1/account

구독 상태 및 남아 있는 크레딧과 같은 귀하의 계정 정보를 알아본다

인수

없음

반응 특성

subscriptionPlan

귀하가 현재 구독한 구독 플랜 또는 "없음".

subscriptionState

현재 구독 상태 ('유효' 또는 '연체') 또는 구독하고 있지 않으면 '종료'.

credits

귀하의 계정에 남아있는 크레딧 숫자. 현재 구독하고 있지 않으면 0.

Username = API Id, Password = API Key

cURL

$ curl "https://clippingmagic.com/api/v1/account" \
 -u 123:[secret]

반응 예

{
  "subscriptionPlan" : "none",
  "subscriptionState" : "ended",
  "credits" : 0
}