Máy Chủ API

Tất cả các yêu cầu API là những yêu cầu HTTP tiêu chuẩn cho các URL kiểu REST. Các phản hồi là JSON hoặc một hình ảnh (khi tải kết quả).

Xác Thực

API sử dụng xác thực truy cập cơ bản HTTP tiêu chuẩn. Tất cả các yêu cầu đối với API sẽ cần có Thông Tin Đăng Nhập API của bạn, cùng với Mã Định Danh API như là người dùng và API Bí Mật như là mật khẩu. Lưu ý rằng ClippingMagic.js chỉ sử dụng Mã Định Danh API của bạn, không tiết lộ API Bí Mật của bạn cho những người dùng.

Bảo Mật

Tất cả yêu cầu phải được thực hiện qua HTTPS và bạn phải xác thực tất cả yêu cầu đó.

Thư viện khách hàng http của bạn phải hỗ trợ Chỉ Định Tên Máy Chủ (SNI) để thực hiện thành công các yêu cầu. Nếu bạn nhận được các lỗi giao tiếp lạ, việc thiếu hỗ trợ SNI có thể chính là lý do.

Phía Người Dùng so với Phía Máy Chủ

Lưu ý rằng tất cả hoạt động tải lên và tải về tiến hành trên máy chủ, nhưng tất cả hoạt động xem xét và chỉnh sửa thực hiện ở Phần Mềm Chỉnh Sửa Thông Minh (Smart Editor).

Việc phân chia này bảo vệ Khoá API của bạn, đồng thời cho phép trải nghiệm người dùng cuối có tính liền mạch trên trang web của bạn.

Giới Hạn Tốc Độ

Việc sử dụng API được giới hạn tốc độ với các hạn mức cho phép mang tính hào phóng và không có giới hạn trần vượt qua điểm API của bạn.

Trong quá trình hoạt động thông thường do người dùng cuối điều khiển, bạn sẽ ít gặp phải bất kỳ giới hạn tốc độ nào vì việc sử dụng có xu hướng tăng giảm theo cách mà dịch vụ xử lý một cách ổn thoả.

Dù vậy, đối với các công việc hàng loạt chúng tôi khuyến khích bắt đầu nhiều nhất là 5 chuỗi, tăng thêm 1 chuỗi mới mỗi 5 phút cho đến khi bạn đạt đến mức độ song song mong muốn. Nếu bạn cần hơn 100 chuỗi cùng lúc, vui lòng liên hệ trước khi bắt đầu.

Nếu bạn gửi quá nhiều yêu cầu thì bạn sẽ bắt đầu nhận các phản hồi 429 Too Many Requests. Khi điều này xảy ra, bạn nên áp dụng linear back off//: trước phản hồi đầu tiên đó, đợi 5 giây cho đến khi gửi yêu cầu tiếp theo. Đối với 429 phản hồi liên tục thứ hai/, hãy đợi 2*5= 10 giây cho đến khi gửi yêu cầu tiếp theo. Đối với thứ bạ, đợi 3*5=15 giây, v.v.

Bạn có thể đặt lại bộ đếm back off sau khi yêu cầu thành công và bạn nên sử dụng back off trên cơ sở mỗi chuỗi (chẳng hạn các chuỗi nên hoạt động độc lập với nhau).

Đối Tượng JSON lỗi

Chúng tôi sử dụng nguyên trạng HTTP quy ước để cho thấy sự thành công hay thất bại của một yêu cầu API và bao gồm những thông tin lỗi quan trọng trong Đối tượng Lỗi JSON (Error JSON Object) được trả về.

Chúng tôi luôn cố gắng trả về Đối tượng Lỗi JSON (Error JSON Object) với bất kỳ yêu nào có vấn đề. Tuy nhiên, có những thất bại của máy chủ nội bộ luôn luôn có thể về mặt lý thuyết mà việc đó dẫn đến phản hồi không không phải do lỗi JSON.

Các Thuộc Tính

statusTrạng thái phản hồi của HTTP được lập lại ở đây để giúp cho việc gỡ lỗi.
codeClipping Magic mã lỗi nội bộ.
messageTin nhắn lỗi người có thể đọc được, dự định có ích trong việc gỡ lỗi.

Nếu trạng thái HTTP đối với yêu cầu của bạn là 200 thì sẽ không có Đối Tượng Lỗi JSON (Error JSON Object) nào được trả về và bạn có thể giả định một cách an toàn nói chung là yêu cầu đã thành công/.

Một số Thư Viện Khách Hàng HTTP đưa ra các lỗi/ về nguyên trạng HTTP/ trong phạm vi 400-599. Bạn sẽ cần nắm lấy các lỗi này và xử lý chúng phù hợp.

HTTP StatusÝ nghĩa
200-299

Thành Công

400-499

Có vấn đề với thông tin được cung cấp trong yêu cầu (chẳng hạn đã mất một tham số). Vui lòng xem xét tin nhắn lỗi để tìm ra cách sửa nó.

500-599

Đã có Clipping Magic mã lỗi nội bộ. Đợi 1 chút rồi thử lại và nếu sự cố cứ tiếp tục tồn tại, vui lòng email cho chúng tôi.

Lỗi API gần đây được liệt kê trên trang tài khoản của bạn để tiện cho bạn gỡ lỗi.

Example Error Response

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

Đối Tượng JSON Hình Ảnh

Các ghi nhận hình ảnh được thể hiện theo cách đồng nhất với một JSON Object, được trả về bởi nhiều tác vụ API.

Các Thuộc Tính

id

Mã định danh duy nhất cho hình ảnh. Cần để người dùng chỉnh sửa hình ảnh và tải về kết quả hình ảnh.

secret

Cần khóa bí mật để chỉnh sửa hình ảnh này bằng ClippingMagic.js

resultRevision

Sống nguyên cho thấy đa số sửa đổi gần đây có sẵn để tải về (0 = chưa cung cấp kết quả).

Cho phép bạn xác định xem có cung cấp kết quả cho hình ảnh này mới hơn hình ảnh được tải về trước đó.

originalFilename

Chuỗi chứa tên tập tin được cung cấp khi tải hình ảnh gốc lên.

test

true có nghĩa đây là hình ảnh kiểm thử tự do xử lý nhưng kết quả sẽ có hình nền mờ.

false có nghĩa đây là hình ảnh sản xuất mà mất điểm để xử lý nhưng kết quả sẽ không có hình nền mờ.

Ví Dụ

{
  "id" : 2346,
  "secret" : "image_secret1",
  "resultRevision" : 0,
  "originalFilename" : "example_image1.jpg",
  "imageCategoryUser" : "Photo",
  "imageCategoryAi" : "Photo",
  "test" : false
}

Tải Lên POST https://clippingmagic.com/api/v1/images

Để tải hình ảnh lên, bạn tải tệp HTTP POST chuẩn. Phải gọi đểm cuối này từ phía máy chủ, không thể gọi nó từ javascript của trang web. Hãy ghi nhớ rằng Loại-Nội Dung phải là multipart/form-data khi tải các tệp nhị phân lên.

Các tham số

Phải cung cấp hình ảnh đầu vào là hình ảnh của:

image
Nhị phân

Tệp nhị phân.

image.base64
Chuỗi

Chuỗi được mã hóa base64. Dãy thông tin này có dung lượng nhiều nhất là 1 megabyte.

image.url
Chuỗi

Một URL để tải.

Phải là tệp .bmp, .gif, .jpeg, .png, hoặc .tiff.

Kích thước tải lên hình ảnh tối đa (= chiều rộng × chiều cao) là 33.554.432 pixels, mà trở nên co nhỏ lại thành 4.194.404 pixels trừ khi ghi đè lên bởi maxPixels dưới đây. Vui lòng co nhỏ hình ảnh của bạn lại trước thành kích thước sau cùng hoặc nhỏ hơn trước khi tải lên.

test
Boolean Boolean
true, false

Gửi true để cho thấy đây là hình ảnh kiểm thử.

Loại bỏ hoặc gửi false cho các sản xuất.

Hình ảnh kiểm thử được tự do xử lý nhưng kết quả sẽ có hình nền mờ được nhúng.

format
Bộ đếm
json, result, clipping_path_svg, clipping_path_tiff, alpha_mask_png

format=json (mặc định): không phát sinh kết quả Auto-Clip và trả về Image JSON object. Sử dụng cái này khi có người thao tác xem xét và có khả năng touch up/ kết quả bằng cách dùng ClippingMagic.js.

format=result phát sinh và lấy kết quả Auto-Clip.

format=clipping_path_svg phát sinh kết quả Auto-Clip và lấy Clipping Path (SVG).

format=clipping_path_tiff tạo ra kết quả Cắt Tự Động và đem về các Đường Cắt (TIFF).

format=alpha_mask_png phát sinh kết quả Auto-Clip và lấy Alpha Mask (PNG). Alph Mask có cùng kích thước như hình ảnh đưa vào. Sử dụng nó cho hình ảnh đưa vào không cho bạn kết quả vì Edge Guard và Halo Scrubber cải thiện màu đường biên.

Trả về idsecret trong x-amz-meta-id và các tiêu đề x-amz-meta-secret khi lấy kết quả không JSON. Hãy chắc chắc lưu giữ những mã này/ thế nên bạn có thể xem lại và chỉnh sửa kết quả của bạn bằng cách dùng ClippingMagic.js. Tât cả các tiêu đề được đưa vào trong phần phản hồi.

Lấy Image JSON Object không tính tiền tài khoản của bạn; bạn chỉ có thể bị tính tiền khi tải kết quả sản phẩm xuống.

maxPixels
Số nguyên
1000000 to 26214400

Thay đổi kích thước hình ảnh tối đa (=chiều rộng × chiều cao) được dùng khi đưa hình ảnh trở lại kích thước yêu cầu sau khi tải lên.

Mặc định: 4.194.404 pixels

background.color
#RRGGBB
#0055FF

Bỏ sự dụng phông nền trong suốt và nhận kết quả PNG.

Kèm để nhận nền không trong suốt theo một màu được chỉ định và kết quả output.opaqueFileFormat (mặc định là JPEG).

Chắc chắn đưa '#' vào.

Cấu hình các tham số xử lý:

processing.mode
Bộ đếm
auto, photo, graphics, scan

Kiểm soát chế độ xử lý được sử dụng cho hình ảnh của bạn.

Mặc định: auto

processing.autoClip
Boolean Boolean
true, false

Cho phép (mặc định) hoặc vô hiệu hóa Auto-Clip khi chỉnh sửa hình ảnh trong ứng dụng web.

Vô hiệu hóa nếu muốn tải lên hình ảnh qua API nhưng rồi cắt ảnh nào đó theo mẫu tự do khác với tiền cảnh rõ ràng (nếu có).

Mặc định: true

processing.autoHair
Boolean Boolean
true, false

Bật (chế độ mặc định) hoặc tắt việc áp dụng mạng che cho tóc.

Mặc định: true

processing.allowGraphicsMode
Boolean Boolean
true, false

Bật (chế độ mặc định) hoặc tắt việc chọn lựa tự động cho Chế Độ Đồ Hoạ.

Cài đặt này không áp dụng khi format=json.

Mặc định: true

processing.allowScanMode
Boolean Boolean
true, false

Bật (chế độ mặc định) hoặc tắt việc chọn lựa tự đồng cho Chế Độ Quét.

Cài đặt này không áp dụng khi format=json.

Mặc định: true

Tùy chỉnh các mức màu:

colors.auto
Boolean Boolean
true, false

Tự động điều chỉnh mức màu để tăng độ tương phản.

Mặc định: false

colors.brightness
Số nguyên
-100 to 100

Điều chỉnh độ sáng của hình ảnh xuất ra.

Mặc định: 0

colors.shadows
Số nguyên
-100 to 100

Điều chỉnh đọ bóng của hình ảnh đưa ra. Các giá trị dương có nghĩa độ bóng tối hơn.

Mặc định: 0

colors.highlights
Số nguyên
-100 to 100

Điều chỉnh độ sáng của hình ảnh xuấtt ra. Giá trị dương có nghĩa là độ sáng nhạt hơn.

Mặc định: 0

colors.temperature
Số nguyên
-100 to 100

Điều chỉnh nhiệt độ màu của hình ảnh xuất ra. Các giá trị dương có nghĩa là màu ấm hơn.

Mặc định: 0

colors.saturation
Số nguyên
-100 to 100

Điều chỉnh độ bảo hòa của hình ảnh xuất ra. Các giá trị dương có nghĩa độ bão hòa hơn.

Mặc định: 0

Tùy chỉnh gỡ bỏ màu ở phông nền mà truyền từ tiền cảnh, như với mành hình màu xanh lá cây.

colorCast.auto
Boolean Boolean
true, false

Tự động xác định màu tiền cảnh để gỡ bỏ khỏi tiền cảnh.

Mặc định: false

colorCast.color
#RRGGBB
#A84400

Màu phông nền được chỉ định thủ công để gỡ bỏ tiền cảnh.

Loại bỏ để tự động phát hiện.

colorCast.foregroundGuard
Trôi nổi
0.0 to 20.0

Các giá trị lớn hơn giảm ảnh hưởng của việc gỡ bỏ cast color trên tiền cảnh thực tương tự với cast color nhưng bão hòa hơn những màu được gỡ bỏ.

Mặc định: 4.0

Tùy chỉnh cân bằng màu trắng:

whiteBalance.auto
Boolean Boolean
true, false

Tự động xác định màu tham khảo để dùng thực hiện việc cân bằng màu trắng.

Mặc định: false

whiteBalance.color
#RRGGBB
#968386

Màu cân bằng trắng được chỉ định thủ công.

Loại bỏ để tự động phát hiện.

Tùy chỉnh cảm ứng hoàn thiện:

effects.dropShadow
[xOffsetPx:int] [yOffsetPx:int] [blurRadiusPx:int, 0 to 75] [opacity:float, 0 to 1]
30 30 25 0.75

Thêm hiệu ứng tạo bóng đổ bằng drop vào kết quả được cắt.

effects.reflection
[yOffsetPx:int, 0 to 400] [heightPx:int, 0 to 800] [opacity:float, 0 to 1]
0 200 0.5

Thêm hiệu ứng phản chiếu vào kết quả được cắt.

Tùy chỉnh các tham số xử lý:

edges.corners
Boolean Boolean
true, false

Sử dụng (mặc định) hoặc vô hiệu Corner Guard.

edges.smoothing
Bộ đếm
smart, fixed

Dùng smart (mặc định) hoặc fixed làm mịn.

edges.smoothingLevel
Trôi nổi
0.0 to 5.0

Tùy chỉnh số lượng làm trơn áp dụng cho kết quả.

Mặc định 1.0

edges.feathering
Bộ đếm
fixed, auto, local

Dùng auto (mặc định), local, hoặc fixed tạo gợn sóng/.

edges.featheringRadiusPx
Trôi nổi
0.0 to 6.0

Tùy chỉnh số lượng feathering ap dụng cho kết quả.

Mặc định: 1.0

edges.offsetPx
Trôi nổi
0.0 to 10.0

Tùy chỉnh boundary offset áp dụng cho kết quả.

Mặc định: 0.0

Làm cho phù hợp kết quả xuất ra

fit.toResult
Boolean Boolean
true, false

Xoay làm kết quả phù hợp trong hoặc ngoài/(mặc định).

Nếu nằm ngoài, phần tham số còn lại trong phần này được bỏ đi có hiệu quả.

fit.paddingPercent
Trôi nổi
0.0 to 35.0

Phần đệm áp dụng gần kết quả phù hợp, là phần trăm kích thước kết quả.

Mặc định: 5.0

fit.paddingPixels
Số nguyên
0 to 250

Phần đệm trong điểm ảnh áp dụng gần kết quả phù hợp.

Nếu không được xác định, thay vào đó sử dụng phần đệm phần trăm.

fit.objectSize
Bộ đếm
small, medium, large

Bạn có thể chỉ định kích thước tổng hợp cho đối tượng của bạn. Việc này có ích cho Thương Mại điện tử trường hợp bạn muốn cho người mua một cảm giác không tốt về kích cỡ sản phẩm liên quan đến các sản phẩm khác.

Mặc định: large (= không đổi kích cỡ kết quả)

fit.verticalAlignment
Bộ đếm
top, middle, bottom

Xác định cách nên điều chỉnh kết quả của bạn nếu có khoảng không gian dọc vượt quá mức.

Cũng áp dụng khi phân chia chỗ vượt quá mức do tỷ lệ khung ảnh hoặc thực thi kích cỡ mục tiêu, xem bên dưới.

Mặc định: middle

fit.shadows
Bộ đếm
ignore, pad, tight

Bạn có thể bỏ đi các bóng ảnh, thêm đệm đều cả hai bên để phù hợp với bóng ảnh, hoặc chỉ thêm đệm khi có nhu cầu để không cắt bỏ bóng ảnh.

Mặc định: pad

fit.rotationDeg
Trôi nổi
-360.0 to 360.0

Xoay hình ảnh. Các giá trị dương ngược chiều kim đồng hồ.

Mặc định: 0

Kiểm soát kích cỡ kết quả và tỷ lệ khung ảnh ratio:

result.aspectRatio
[width:float, >0]:[height:float, >0]
4:3

Bảo đảm kết quả có tỷ lệ khung ảnh được quy định.

fit.verticalAlignment kiểm soát cách phân phối khoảng trắng dọc.

Mặc Định: không áp dụng

result.targetSize
[width:int, >0] [height:int, >0]
400 300

Bảo đảm rằng kết quả có kích cỡ được quy định.

fit.verticalAlignment kiểm soát cách phân phối khoảng trắng dọc.

Mặc Định: không áp dụng

result.allowEnlarging
Boolean Boolean
true, false

Kiểm soát xem kết quả được phép có lớn hơn hình ảnh nhận vào hay không.

Mặc định: false

Kiểm soát các tùy chọn xuất ra:

output.dpi
Số nguyên
1 to 4000

Đặt thông tin DPI được nhúng vào kết quả.

Không bao gồm thông tin DPI nếu kết quả là web được tối ưu hóa.

Mặc định: 72

output.colorSpace
Bộ đếm
sRGB, AdobeRGB, AppleRGB, ColorMatchRGB

Đặt thông tin không gian màu được nhúng vào kết quả.

Không bao gồm thông tin không gian màu nếu kết quả là web được tối ưu hóa.

Mặc định: sRGB

output.jpegQuality
Số nguyên
1 to 100

Tùy chỉnh cài đặt chất lượng được sử dụng khi tạo ra kết quả JPEG.

Mặc định: 75

output.pngOptimization
Bộ đếm
none, lossless, lossy

Tùy chỉnh tối ưu các kết quả PNG của web.

Mặc định: lossless

output.jpegOptimization
Bộ đếm
none, enabled

Tùy chỉnh tối ưu các kết quả PNG của web.

Mặc định: enabled

output.opaqueFileFormat
Bộ đếm
jpeg, png

Tùy chỉnh định dạng tệp để sử dụng cho các kết quả đục.

Mặc định: jpeg

Bạn có thể tải lên các hình ảnh trong chế độ kiểm thử mà không cần đăng ký. Tuy nhiên, cho dù việc tải lên không mất điểm, bạn cũng cần đăng ký API hợp lệ để tải lên các hình ảnh sản xuất qua API.

Hãy dùng thử


Định Dạng: '#RRGGBB'



Định Dạng: '#RRGGBB'

Định Dạng: '#RRGGBB'


Định dạng: '[xOffsetPx:int] [yOffsetPx:int] [blurRadiusPx:int, 0 to 75] [opacity:float, 0 to 1]'
Ví dụ: 30 30 25 0.75

Định dạng: '[yOffsetPx:int, 0 to 400] [heightPx:int, 0 to 800] [opacity:float, 0 to 1]'
Ví dụ: 0 200 0.5




Định dạng: '[width:float, >0]:[height:float, >0]'
Ví dụ: 4:3

Định dạng: '[width:int, >0] [height:int, >0]'
Ví dụ: 400 300

Người dùng = id API, Hộ chiếu = Bí mật API

cURL

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

Giả định 'example.jpg' tồn tại. Hãy thay thế khi phù hợp. Sắp xếp với tùy chọn'test=true'.

Example Response

{
  "image" : {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }
}

Tải Về GET https://clippingmagic.com/api/v1/images/[imageId]

Để tải về kết quả, bạn thực hiện HTTP GET tiêu chuẩn. Phải chắc chắn đã tạo kết quả trước.

Các kết quả kiểm thử được tự do tải về nhưng bao gồm hình nền mờ. Các kết quả sản xuất mất một điểm để tải về lần đầu tải chúng về; những lần tải về lập lại miễn phí.

Nếu không có sẵn kết quả thì bạn sẽ nhận được một phản hồi lỗi.

Các tham số

imageId

Được đính kèm trong URL

Bạn sẽ cần phải chèn giá trị id được trả về trong gọi Tải Lên.

Không bắt buộc
format

format=result (mặc định) tải hình ảnh kết quả.

format=clipping_path_svg thay vì vậy tải Clipping Path (SVG).

format=clipping_path_tiff sẽ đem về Đường Cắt (TIFF).

format=alpha_mask_png thay vì vậy tải Alpha Mask (PNG).

format=json thay vì vậy tải Image JSON Object. Có ích nếu bạn muốn kiểm tra trên resultRevision hoặc nếu bạn mất khóa bí mật hình ảnh.

Lấy Image JSON Object không tính tiền tài khoản của bạn; bạn chỉ có thể bị tính tiền khi tải kết quả sản phẩm xuống.

Các Tiêu Đề Phản Hồi

Khi format không phải là json chúng tôi cung cấp thông tin khkoa1 trong tiêu đề phản hồi HTTP

x-amz-meta-id
Example: 2346

Hình ảnh của bạn là id.

x-amz-meta-secret
Example: image_secret1

Hình ảnh của bạn là secret.

x-amz-meta-resultrevision
Example: 1

resultRevision mà bạn đang tải theo yêu cầu này.

Mỗi lần tạo một kết quả mới, bộ đếm này được tăng dần.

x-amz-meta-width
Example: 3200
(chỉ được đưa vào cho format=result)

Chiều rông trong các điểm ảnh của kết quả mà bạn đang tải theo yêu cầu này.

x-amz-meta-height
Example: 2400
(chỉ được đưa vào cho format=result)

Chiều cao trong các điểm ảnh của kết quả mà bạn đang tải theo yêu cầu này.

Content-Disposition
Example: attachment; filename*=UTF-8''example_image1_clipped_rev_0.png

Tên tệp kết quả, bao gồm mở rộng.

Người dùng = id API, Hộ chiếu = Bí mật API

cURL

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

Example JSON Response

{
  "image" : {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }
}

Danh Sách GET https://clippingmagic.com/api/v1/images

Để tải danh sách các Image JSON Object của bạn, bạn thực hiện HTTP GET tiêu chuẩn.

Các tham số

Không bắt buộc
limit

Số bản ghi cần tải. Các mặc định cho 20 (Tối thiểu 1, tối đa 100).

Không bắt buộc
offset

Offset sử dụng trong danh sách các ghi nhận (mặc định đến 0)

Các Thuộc Tính Phản Hồi

images

Một mảng Image JSON Objects.

limit

limit được sử dụng thực sự khi tạo ra kết quả.

offset

offset được sử dụng thực sự khi tạo ra kết quả.

Người dùng = id API, Hộ chiếu = Bí mật API

cURL

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

Example Response

{
  "images" : [ {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }, {
    "id" : 2347,
    "secret" : "image_secret2",
    "resultRevision" : 0,
    "originalFilename" : "example_image2.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  } ],
  "limit" : 2,
  "offset" : 0
}

Xoá POST https://clippingmagic.com/api/v1/images/[imageId]/delete

Để xóa hình ảnh, bạn làm phương pháp HTTP POST tiêu chuân để xóa URL.

Đây là sự lệch nhẹ từ thực hành REST tiêu chuẩn để xử lý thực tế mà nhiều thư viện khách hàng HTTP không hỗ trợ động từ HTTP DELETE trong khi tránh sự lộn xộn có nhiều cách làm cùng một việc.

Các tham số

imageId

Được đính kèm trong URL

Bạn sẽ cần phải chèn giá trị id được trả về trong gọi Tải Lên.

Các Thuộc Tính Phản Hồi

image

Image JSON Object bị xóa.

Hãy dùng thử

Người dùng = id API, Hộ chiếu = Bí mật API

cURL

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

Example Response

{
  "image" : {
    "id" : 2346,
    "secret" : "image_secret1",
    "resultRevision" : 0,
    "originalFilename" : "example_image1.jpg",
    "imageCategoryUser" : "Photo",
    "imageCategoryAi" : "Photo",
    "test" : false
  }
}

Tài Khoản GET https://clippingmagic.com/api/v1/account

Lấy thông tin cơ bản về tài khoản của bạn như tình trạng đăng ký và số điểm còn lại của bạn.

Các tham số

Không Có

Các Thuộc Tính Phản Hồi

subscriptionPlan

Gói đăng hiện mà hiện nay bạn được đăng ký cho hoặc 'không'/.

subscriptionState

Tình trạng đăng ký hiện nay của bạn ('hoạt động hoặc 'Quá hạn') hoặc đã kết thúc nếu không có đăng ký.

credits

Số điểm API còn lại trong tài khoản của bạn. 0 nếu hiện tại không có đăng ký hoặc đã đăng ký chương trình không phải API.

Người dùng = id API, Hộ chiếu = Bí mật API

cURL

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

Example Response

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