호스팅된 스마트 편집기

Clipping Magic 스마트 편집기를 맞춤형 워크플로우에 통합하는 가장 쉬운 방법입니다.

통합 절차

반드시 빠른 시작을 먼저 읽으십시오.

  1. 서버 API를 사용하여 이미지를 업로드하십시오.

  2. 호스팅된 스마트 편집기 URL를 작성하고 귀하의 운용자를 그곳으로 인도하여, 귀하가 지정한 이미지를 클립할 수 있습니다.

  3. 모든 이미지들을 클립핑한 후, 귀하의 운용자의 브라우저가 클립핑 세션에 관한 관련된 정보를 포함하는 HTTP POST를 갖고 지정된 돌아가기 URL로 이동합니다.

화이트 라벨 해결 방법이 필요하거나 또는 모든 이미지를 위하여 콜백할 때는, 화이트 라벨 스마트 편집기를 참조하십시오.

호스팅된 스마트 편집기 URL https://clippingmagic.com/api/v1/hosted/[apiId]

간단한 URL을 만들고 귀하의 운용자가 ㅂ라우저에서 그것을 열고 귀하의 이미지를 검토 및 편집하도록 하십시오.

호스팅된 스마트 편집기 URL는 다음 변수를 지원합니다.

images
id1:secret1,id2:secret2,...
123:abc,456:def
요구사항

클립할 이미지. 쉼표로 구분된 목록의 id:secret 쌍. 서버 API로 이미지를 업로드하면 이것들을 얻습니다.

returnUrl
문자열
요구사항

귀하의 운용자가 클립핑을 끝내면, 그들의 브라우저가 이 URL에 HTT POST를 발행합니다. 아래의 상세한 내역을 참조하십시오.

useStickySettings
부울
true, false

useStickySettings=true를 패스하면, 편집기는 이미지를 업로드할 때 사용된 사용자를 위하여 현재 구성된 고정 설정을 사용합니다.

이는 기본 클리핑 설정을 한번만 구성하고, 편집하는 모든 이미지에 전체 사용할 수 있습니다.

Read about how to configure the sticky settings

미리-자르기는 API를 통하여 제공되지 않으나, API 업로드 콜에서 이미지 크기 제한을 설정할 수 있습니다.

locale
문자열

편집기에 사용되는 디스플레이 언어. 생략하면 기본값은 영어. 유효한 값들은:

코드디스플레이 언어
en-US English (영어)
de-DE Deutsch (독일어)
es-ES Español (스페인어)
fr-FR Français (프랑스어)
hi-IN हिन्दी (힌디어)
id-ID Indonesia (인도네시아어)
it-IT Italiano (이탈리아어)
ja-JP 日本語 (일본어)
ko-KR 한국어
pl-PL Polski (폴란드어)
pt-BR Português (포르투갈어)
ru-RU Русский (러시아어)
th-TH ไทย (태국어)
tr-TR Türkçe (터키어)
vi-VN Tiếng Việt (베트남어)
zh-Hans-CN 简体中文 (중국어)
zh-Hant-TW 繁體中文 (중국어)

현대 브라우저는 매우 긴 URL을 허용하지만, 레거시 브라우저를 지원하고 30 이상의 이미지를 클립하는 것을 지원하려면, 직접 링크를 사용하는 대신에 POST에 제출할 수 있습니다.

단일 이미지 URL 예


https://clippingmagic.com/api/v1/hosted/123?images=2345:image_secret&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

하나의 이미지를 지정할 때 편집기에는 '건너뛰기' 버튼이 없으며 클립할 나머지 이미지의 숫자를 나타내지 않습니다.

다수 이미지 URL 예


https://clippingmagic.com/api/v1/hosted/123?images=2345:image_secret,2346:image_secret2&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

다수의 이미지를 지정할 때 편집기에는 '건너뛰기' 버튼이 있으며 클립할 나머지 이미지의 숫자를 나타냅니다.

돌아가기 URL

귀하의 운용자가 클립핑을 끝내면, 그들의 브라우저가 귀하가 선정한 돌아가기 URL에 HTT POST를 발행합니다. 그 POST는 그 본체에 하나의 매개 변수를 포함합니다: clippingMagicJson 그 매개 변수의 내용을 분석하면, 어떤 이미지가 클립되었는지에 관한 정보가 있는 JSON 개체로 풀립니다. 그 후 다운로드 서버 API를 사용하여 지금 막 사용할 수 있는 결과를 다운로드할 수 있습니다.

event
열거형
editor-exit, error

editor-exit는 클립핑 세션이 성공적으로 완료되었음을 의미합니다.

error는 오류가 발생하였음을 의미하며 아래의 error가 채워집니다.

images
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"},{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
호스팅된 편집기 URL에 제공된 이미지의 배열.
clipped
[{"id":1,"secret":"secret1"},{"id":2,"secret":"secret2"}]
예를 들어 운용자가 편집기에서 '완료'를 클릭하였을 때의 이미지와 같이 본 세션에서 실제로 클립된 이미지 배열.
skipped
[{"id":3,"secret":"secret3"},{"id":4,"secret":"secret4"}]
예를 들어 운용자가 편집기에서 '건너뛰기'를 클릭하였을 때의 이미지와 같이 본 세션에서 실제로 건너뛰기한 이미지 배열.

event=error인 경우, 아래와 같이 채워진 error 멤버 개체가 있을것입니다.

error.status
정수
HTTP-상태-같은 코드. 4xx는 발신자 오류를 의미합니다. 5xx는 내부 서버 오류를 의미합니다.
error.code
정수
발생한 오류를 고유하게 식별하는 숫자.
error.message
문자열
발생한 오류를 설명하는 사람이 읽을 수 있는 오류 메시지.

POST가 성공하려면 모든 CSRF 체크를 비활성화 하거나 돌아가기 URL에 CSRF 토큰을 추가하여야 합니다.

운용자가 그들의 브라우저를 닫거나 분석할 수 없는 호스팅된 편집기 URL을 사용하면, 돌아가기 URL이 호출되지 않습니다.

성공 예 clippingMagicJson는 아래와 같이 디코드됩니다:
{
  "event" : "editor-exit",
  "images" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ],
  "skipped" : [ ]
}
귀하의 돌아가기 URL을 테스트하십시오.
오류 예 clippingMagicJson는 아래와 같이 디코드됩니다:
{
  "event" : "error",
  "error" : {
    "status" : 400,
    "code" : 1234,
    "message" : "Example error"
  },
  "images" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ ],
  "skipped" : [ {
    "id" : 2345,
    "secret" : "image_secret"
  }, {
    "id" : 2346,
    "secret" : "image_secret2"
  } ]
}
귀하의 돌아가기 URL을 테스트하십시오.