รับคีย์ API

ตัวแก้ไขแบบอัจฉริยะที่มีโฮสต์

วิธีที่ง่ายที่สุดในการผนวกรวมตัวแก้ไขแบบอัจฉริยะ Clipping Magic เข้าไปในกระแสงานที่คุณกำหนดเอง

ขั้นตอนการผนวกรวม

ก่อนอื่น อย่าลืมอ่าน เริ่มต้นใช้งานด่วน

  1. อัปโหลดภาพโดยใช้ API ของเซิร์ฟเวอร์

  2. สร้าง URL ตัวแก้ไขแบบอัจฉริยะที่มีโฮสต์ แล้วแจ้งให้บุคลากรที่ปฏิบัติงานทราบว่าเป็นจุดที่ต้องคลิปภาพที่คุณระบุไว้

  3. หลักจากที่คลิปภาพทั้งหมดแล้ว เบราว์เซอร์ของผู้ปฏิบัติงานจะพาไปยัง URL การส่งคืน ที่ระบุไว้พร้อมด้วย HTTP POST ซึ่งมีข้อมูลที่เกี่ยวข้องกับเซสชันการคลิป

หากคุณจำเป็นต้องมีไวท์เลเบลหรือคอลแบ็กสำหรับทุกภาพที่คลิปไว้ กรุณาอ่าน ตัวแก้ไขไวท์เลเบลแบบอัจฉริยะ

URL ตัวแก้ไขแบบอัจฉริยะที่มีโฮสต์ https://clippingmagic.com/api/v1/hosted/[apiId]

คุณสามารถสร้าง URL แบบง่ายและให้ผู้ปฏิบัติงานเปิดขึ้นในเบราว์เซอร์ เพื่อตรวจสอบและแก้ไขภาพของคุณตั้งแต่หนึ่งภาพขึ้นไป

URL ตัวแก้ไขแบบอัจฉริยะที่มีโฮสต์ จะรองรับพารามิเตอร์ดังต่อไปนี้ :

images
id1:secret1,id2:secret2,...
123:abc,456:def
จำเป็นต้องมี

ภาพที่จะคลิป รายการคู่ id:secret ที่มีเครื่องหมายจุลภาคคั่นไว้ คุณจะได้รับจากการอัปโหลดภาพด้วย API ของเซิร์ฟเวอร์

returnUrl
สตริง
จำเป็นต้องมี

เมื่อผู้ปฏิบัติงานของคุณทำการคลิปเสร็จเรียบร้อยแล้ว เบราว์เซอร์เหล่านั้นจะส่ง HTTP POST ไปยัง URL นี้ กรุณาดูรายละเอียดด้านล่าง

useStickySettings
บูลีน
true, false

หากคุณส่ง useStickySettings=true เข้าไป ตัวแก้ไขจะใช้การตั้งค่าติดแน่นที่กำหนดไว้ในขณะนี้สำหรับผู้ใช้ที่เป็นเจ้าของคีย์ API ที่ใช้เพื่ออัปโหลดภาพ

วิธีนี้จะช่วยให้คุณกำหนดค่าในการตั้งค่าการคลิปพื้นฐานเพียงครั้งเดียว เพื่อให้นำไปปรับใช้กับทุกภาพที่คุณแก้ไข

Read about how to configure the sticky settings

การตัดต่อล่วงหน้าไม่มีให้ใช้ได้โดยอาศัย API แต่คุณสามารถกำหนดค่าขีดจำกัดขนาดภาพได้ในการเรียกอัปโหลด API

ค่าเริ่มต้น : false

hideBottomToolbar
บูลีน
true, false

จะซ่อนแถบเครื่องมือด้านล่างสุดไว้ จึงทำให้การตั้งค่าเหล่านั้นไม่พร้อมใช้งานในตัวแก้ไข

ค่าเริ่มต้น : false

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=2346:image_secret1&returnUrl=https%3A%2F%2Fclippingmagic.com%2Fapi%2FreturnUrlExample

เมื่อระบุว่าเป็นภาพเดี่ยว ตัวแก้ไขจะไม่มีปุ่ม 'ข้าม' และไม่แสดงให้เห็นจำนวนภาพที่ยังคงเหลือให้คลิป

ตัวอย่าง URL สำหรับหลายภาพ



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

เมื่อระบุว่าเป็นหลายภาพ ตัวแก้ไขจะมีปุ่ม 'ข้าม' และแสดงให้เห็นจำนวนภาพที่ยังคงเหลือให้คลิป

URL การส่งคืน

เมื่อผู้ปฏิบัติงานของคุณทำการคลิปเสร็จเรียบร้อยแล้ว เบราว์เซอร์ของคุณจะส่ง HTTP POST ไปยัง URL การส่งคืน ที่คุณระบุไว้ POST นั้นจะมีพารามิเตอร์เดียวในเนื้อความ : clippingMagicJson เมื่อคุณแยกวิเคราะห์เนื้อหาของพารามิเตอร์นั้น มันจะแยกออกเป็นออบเจ็กต์ JSON พร้อมข้อมูลเกี่ยวกับภาพที่ถูกคลิป จากนั้นคุณสามารถดาวน์โหลดผลลัพธ์ที่พร้อมให้ใช้งานได้ทันที โดยใช้ API ของเซิร์ฟเวอร์ดาวน์โหลด

event
Enum
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
สตริง 		ข้อความแสดงข้อผิดพลาดที่มนุษย์สามารถอ่านได้ ซึ่งอธิบายข้อผิดพลาดที่เกิดขึ้น

คุณจำเป็นจะต้องปิดใช้งานการตรวจสอบ CSRF หรือเพิ่มโทเค็น CSRF ไปยัง URL การส่งคืน เพื่อให้ POST ประสบผลสำเร็จ

หากผู้ปฏิบัติงานของคุณปิดเบราว์เซอร์ลง หรือคุณใช้ URL ของตัวแก้ไขแบบอัจฉริยะที่มีโฮสต์และแยกวิเคราะห์ไม่ได้ ก็จะไม่มีการเรียก URL การส่งคืน

ตัวอย่างผลสำเร็จ clippingMagicJson ถอดรหัสไปเป็น : 
{
  "event" : "editor-exit",
  "images" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ],
  "skipped" : [ ]
}
ทดสอบ URL การส่งคืนของคุณ
ตัวอย่างข้อผิดพลาด clippingMagicJson ถอดรหัสไปเป็น : 
{
  "event" : "error",
  "error" : {
    "status" : 400,
    "code" : 1234,
    "message" : "Example error"
  },
  "images" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ],
  "clipped" : [ ],
  "skipped" : [ {
    "id" : 2346,
    "secret" : "image_secret1"
  }, {
    "id" : 2347,
    "secret" : "image_secret2"
  } ]
}
ทดสอบ URL การส่งคืนของคุณ