Server-API

Alle API-Anfragen sind standardmäßige HTTP-Anfragen an REST-Style URLs. Die Antworten sind entweder JSON oder ein Bild (wenn das Ergebnis abgerufen wird).

Authentifizierung

Die API verwendet eine standardmäßige HTTP Basic Access Authentication. Alle Anfragen an die API müssen Ihre API-Zugangsdaten enthalten, wobei die API-ID als Benutzer und der API-Schlüssel als Kennwort fungieren. Beachten Sie, dass ClippingMagic.js nur Ihre API-ID verwendet, damit Ihr API-Schlüssel für Ihre Benutzer nicht sichtbar ist.

Sicherheit

Alle Anfragen müssen über HTTPS erfolgen, und Sie müssen alle Anfragen authentifizieren.

Ihre HTTP-Client-Bibliothek muss die Servernamensanzeige (Server Name Indication (SNI)) unterstützen, damit Anfragen erfolgreich gestellt werden können. Wenn seltsame Handshake-Fehler auftreten, ist dies wahrscheinlich die Ursache.

Backend i. Vgl. zu Frontend

Beachten Sie, dass sich alle Upload- und Download-Vorgänge auf dem Backend abspielen, aber alle Prüf- und Bearbeitungsvorgänge im Smart-Editor ausgeführt werden.

Durch diese Trennung wird der API-Schlüssel geschützt, aber auch gleichzeitig auf Ihrer Website eine nahtlose Endbenutzererfahrung gewährleistet.

Geschwindigkeitsbegrenzung

Die Verwendung der API unterliegt einer Geschwindigkeitsbegrenzung mit großzügigen Limits und keiner festen Obergrenze über Ihre API-Punkte hinaus.

Während des normalen vom Endbenutzer gesteuerten Betriebs sind Geschwindigkeitsbegrenzungen sehr unwahrscheinlich, da die Nutzung graduell ab- und zunimmt, sodass der Dienst reibungslos ausgeführt werden kann.

Bei Stapelaufträgen empfehlen wir jedoch, mit höchstens 5 Threads zu beginnen und dann alle 5 Minuten 1 neuen Thread hinzuzufügen, bis der gewünschte Parallelitätsgrad erreicht ist. Lassen Sie uns bitte vor Beginn wissen, wenn Sie mehr als 100 gleichzeitige Threads benötigen.

Wenn zu viele Anfragen eingereicht werden, erhalten Sie in zunehmendem Maße die Antwort 429 Too Many Requests. In diesem Fall sollten Sie den Vorgang linear zurückfahren: nach der ersten dieser Antworten warten Sie 5 Sekunden, bis Sie die nächste Anfrage einreichen. Bei der zweiten aufeinanderfolgenden 429-Antwort warten Sie 2*5=10 Sekunden, bis Sie die nächste Anfrage einreichen. Bei der dritten Antwort warten Sie 3*5=15 Sekunden usw.

Sie können den Rückfahrzähler nach einer erfolgreichen Anfrage zurücksetzen und sollten das Rückfahren pro Thread vornehmen (d. h. die Threads sollten unabhängig voneinander ausgeführt werden).

Fehler-JSON-Objekt

Wir verwenden herkömmliche HTTP-Status, um den Erfolg oder Fehlschlag einer API-Anfrage anzuzeigen, und stellen wichtige Fehlerinformationen im zurückgegebenen Fehler-JSON-Objekt bereit.

Wir versuchen, bei einer problematischen Anfrage immer ein Fehler-JSON-Objekt zurückzugeben. Es ist jedoch theoretisch möglich, dass interne Serverfehler auftreten, die zu Nicht-JSON-Fehlerantworten führen.

Attribute

statusDer HTTP-Status der Antwort, der hier zur Unterstützung des Debugging wiederholt wird.
codeInterner Fehlercode in Clipping Magic.
messageVisuell lesbare Fehlermeldung, die für das Debugging hilfreich sein soll.

Wenn der HTTP-Status für Ihre Anfrage 200 ist, wird kein Fehler-JSON-Objekt zurückgegeben, und Sie können mit großer Sicherheit davon ausgehen, dass die Anfrage generell erfolgreich war.

Manche HTTP-Client-Bibliotheken führen für HTTP-Status im Bereich 400-599 zu Ausnahmen. Diese Ausnahmen müssen erfasst und entsprechend behandelt werden.

HTTP StatusBedeutung
200-299

Erfolg

400-499

Es gibt ein Problem bei den in der Anfrage angegebenen Informationen (es fehlt z. B. ein Parameter). Prüfen Sie bitte die Fehlermeldung, um eine Methode zu finden, den Fehler zu beheben.

500-599

In Clipping Magic ist ein interner Fehler aufgetreten. Warten Sie einen Moment und versuchen Sie es erneut. Wenn das Problem immer noch auftritt, schicken Sie uns eine E-Mail.

Beispiel für eine Fehlerantwort

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

Bild-JSON-Objekt

Bilddatensätze werden mit einem JSON-Objekt, das von mehreren der API-Aktionen zurückgegeben wird, einheitlich dargestellt.

Attribute

id

Für das Bild eindeutiger Bezeichner. Wird vom Benutzer zum Bearbeiten des Bildes und Herunterladen des Ergebnisses benötigt.

secret

Der geheime Schlüssel, der zur Bearbeitung dieses Bildes mit ClippingMagic.js

erforderlich ist
resultRevision

Ganzzahl, die die neueste Version angibt, die heruntergeladen werden kann (0 = noch kein Ergebnis erhältlich).

Damit können Sie feststellen, ob es für dieses Bild ein neueres Ergebnis gibt als das zuvor heruntergeladene.

originalFilename

Eine Zeichenfolge, die den Dateinamen enthält, der beim Hochladen des Originalbildes angegeben wurde.

test

true bedeutet, dass es sich um ein Testbild handelt, das kostenlos verarbeitet werden kann, dessen Ergebnis jedoch ein Wasserzeichen enthalten wird.

false bedeutet, dass es sich um ein Produktionsbild handelt, dessen Verarbeitung Punkte kostet, dessen Ergebnis jedoch kein Wasserzeichen enthalten wird.

Beispiel

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

Hochladen POST https://clippingmagic.com/api/v1/images

Zum Hochladen eines Bildes führen Sie einen standardmäßigen HTTP POST-Dateiupload durch. Dieser Endpunkt muss von Ihrem Backend abgerufen werden. Er kann nicht von Ihrem Webseiten-Javascript abgerufen werden. Denken Sie daran, dass der Inhaltstyp als multipart/form-data vorliegen muss, wenn binäre Dateien hochgeladen werden.

Parameter

Das Eingabebild muss in einem der folgenden Formate bereitgestellt werden:

image
Binär

Eine binäre Datei.

image.base64
Zeichenfolge

als base64-codierte Zeichenfolge Die Zeichenfolge kann höchstens 1 Megabyte umfassen.

image.url
Zeichenfolge

als abzurufende URL

Muss eine .bmp-, .gif-, .jpeg-, .png-, oder .tiff-Datei sein.

Die maximale Upload-Größe für Bilder (= Breite × Höhe) ist 33.554.432 Pixel. Diese Größe wird auf 4.194.404 Pixel reduziert, sofern dies nicht von dem Wert für maxPixels weiter unten überschrieben. Verkleinern Sie Ihre Bilder bitte auf die letztgenannte oder eine kleinere Größe, bevor Sie sie hochladen.

test
Boolesch
true, false

Übergeben Sie true, um anzuzeigen, dass es sich um ein Testbild handelt.

Lassen Sie dies aus oder übergeben Sie false für Produktionsbilder.

Testbilder werden kostenlos verarbeitet, aber in das Ergebnis wird ein Wasserzeichen eingebettet.

format
Enum
json, result, clipping_path_svg, alpha_mask_png

format=json (Standardeinstellung): es wird kein automatisches Beschneideergebnis erzeugt, und das Bild-JSON-Objekt wird zurückgegeben. Verwenden Sie diese Einstellung, wenn ein menschlicher Bediener das Ergebnis mit ClippingMagic.js überprüft und eventuell nachbessert.

format=result erzeugt das automatische Beschneideergebnis und ruft es ab.

format=clipping_path_svg erzeugt das automatische Beschneideergebnis und ruft den Clipping-Pfad (SVG) ab.

format=alpha_mask_png erzeugt das automatische Beschneideergebnis und ruft die Alphamaske (PNG) ab. Die Alphamaske hat dieselbe Größe wie das Eingabebild. Wenn sie auf das Eingabebild angewendet wird, erhalten Sie nicht das Ergebnis, da der Kantenschutz und Lichtsaumbereiniger die Grenzfarben verbessern.

id und secret werden in den Kopfzeilen x-amz-meta-id und x-amz-meta-secret zurückgegeben, wenn ein Nicht-JSON-Ergebnis abgerufen wird. Stellen Sie sicher, dass sie gespeichert werden, damit Sie Ihr Ergebnis mit ClippingMagic.js überprüfen und bearbeiten können. Siehe alle in der Antwort enthaltenen Kopfzeilen

Beim Abruf des Bild-JSON-Objekts wird Ihr Konto nicht belastet; Ihnen werden nur heruntergeladene Produktionsergebnisse in Rechnung gestellt.

maxPixels
Ganzzahl
1000000 bis 26214400

Ändert die maximal verwendete Bildgröße (= Breite × Höhe), wenn die Größe des Bildes nach dem Hochladen geändert wird.

Standardwert: 4.194.404 Pixel

background.color
#RRGGBB
#0055FF

Lassen Sie dies aus, um einen durchsichtigen Hintergrund zu verwenden.

Geben Sie auf jeden Fall „#“ mit ein.

Konfigurieren Sie die Verarbeitungsparameter:

processing.mode
Enum
auto, photo, graphics, scan

Steuern Sie den für Ihr Bild verwendeten Verarbeitungsmodus.

Standardeinstellung: auto

processing.autoClip
Boolesch
true, false

Aktivieren (Standardeinstellung) oder deaktivieren Sie das automatische Beschneiden, wenn Sie das Bild in der Web-App bearbeiten.

Deaktivieren Sie diese Einstellung, wenn Sie Bilder über die API hochladen möchten. Führen Sie dann jedoch ein freies Beschneiden derjenigen Bereiche durch, bei denen es sich nicht offensichtlich um Vordergrund handelt (falls vorhanden).

Standardeinstellung: true

processing.autoHair
Boolesch
true, false

Aktivieren (Standardeinstellung) oder deaktivieren Sie die Anwendung einer automatischen Haarmaske.

Standardeinstellung: true

processing.allowGraphicsMode
Boolesch
true, false

Aktivieren (Standardeinstellung) oder deaktivieren Sie die automatische Auswahl des Grafikmodus.

Diese Einstellung gilt nicht, wenn format=json.

Standardeinstellung: true

processing.allowScanMode
Boolesch
true, false

Aktivieren (Standardeinstellung) oder deaktivieren Sie die automatische Auswahl des Scanmodus.

Diese Einstellung gilt nicht, wenn format=json.

Standardeinstellung: true

Konfigurieren Sie die Farbintensität:

colors.auto
Boolesch
true, false

Damit wird die Farbintensität automatisch angepasst, um den Kontrast zu verstärken.

Standardeinstellung: false

colors.brightness
Ganzzahl
-100 bis 100

Damit wird die Helligkeit des Ausgabebildes angepasst.

Standardeinstellung: 0

colors.shadows
Ganzzahl
-100 bis 100

Damit werden die Schatten des Ausgabebildes angepasst. Positive Werte bedeuten dunklere Schatten.

Standardeinstellung: 0

colors.highlights
Ganzzahl
-100 bis 100

Damit werden die Highlights des Ausgabebildes angepasst. Positive Werte bedeuten hellere Highlights.

Standardeinstellung: 0

colors.temperature
Ganzzahl
-100 bis 100

Damit wird die Farbtemperatur des Ausgabebildes angepasst. Positive Werte bedeuten wärmere Farben.

Standardeinstellung: 0

colors.saturation
Ganzzahl
-100 bis 100

Damit wird die Sättigung des Ausgabebildes angepasst. Positive Werte bedeuten mehr Sättigung.

Standardeinstellung: 0

Konfigurieren Sie das Entfernen einer Farbe aus dem Hintergrund, die einen Farbstich im Vordergrund erzeugt, z. B. bei Verwendung eines Green-Screens:

colorCast.auto
Boolesch
true, false

Bestimmt automatisch die Hintergrundfarbe, die aus dem Vordergrund entfernt werden soll.

Standardeinstellung: false

colorCast.color
#RRGGBB
#A84400

Die manuell bestimmte Hintergrundfarbe, die aus dem Vordergrund entfernt werden soll.

Lassen Sie dies aus, um eine automatische Erkennung zu ermöglichen.

colorCast.foregroundGuard
Gleitkomma
0.0 bis 20.0

Größere Werte reduzieren die Auswirkung des Entfernens von Farbstich bei echten Vordergrundfarben, die den Farbstichfarben ähneln, jedoch gesättigter sind als die zu entfernenden Farben.

Standardeinstellung: 4.0

Konfigurieren Sie den Weißabgleich:

whiteBalance.auto
Boolesch
true, false

Bestimmt automatisch die Referenzfarbe, die zur Durchführung von Weißabgleich verwendet werden soll.

Standardeinstellung: false

whiteBalance.color
#RRGGBB
#968386

Die manuelle bestimmte Weißabgleichfarbe.

Lassen Sie dies aus, um eine automatische Erkennung zu ermöglichen.

Konfigurieren Sie das Feilen:

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

Fügt dem beschnittenen Ergebnis einen Schlagschatten-Effekt hinzu.

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

Fügt dem beschnittenen Ergebnis einen Spiegelungs-Effekt hinzu.

Konfigurieren Sie die Randparameter:

edges.corners
Boolesch
true, false

Verwenden Sie die (Standardeinstellung) oder deaktivieren Sie den Eckenschutz.

edges.smoothing
Enum
smart, fixed

Verwenden Sie smart (Standardeinstellung) oder fixed Glättung.

edges.smoothingLevel
Gleitkomma
0.0 bis 5.0

Konfigurieren Sie den Wert der Glättung, die auf das Ergebnis angewendet wird.

Standardeinstellung 1.0

edges.feathering
Enum
fixed, auto, local

Verwenden Sie auto (Standardeinstellung), local oder fixed weiche Kante.

edges.featheringRadiusPx
Gleitkomma
0.0 bis 6.0

Konfigurieren Sie den Wert für weiche Kante, der auf das Ergebnis angewendet wird.

Standardeinstellung: 1.0

edges.offsetPx
Gleitkomma
0.0 bis 10.0

Konfigurieren Sie den Versatz der Grenze, der auf das Ergebnis angewendet wird.

Standardeinstellung: 0.0

Passen Sie die Ausgabe an das Ergebnis an

fit.toResult
Boolesch
true, false

Schalten Sie An Ergebnis anpassen ein oder aus (Standardeinstellung).

Wenn diese Einstellung ausgeschaltet ist, werden die restlichen Parameter in diesem Abschnitt effektiv ignoriert.

fit.paddingPercent
Gleitkomma
0.0 bis 35.0

Das Auffüllen um das angepasste Ergebnis als Prozentsatz der Ergebnisgröße.

Standardeinstellung: 5.0

fit.paddingPixels
Ganzzahl
0 bis 250

Das Auffüllen in Pixeln um das angepasste Ergebnis.

Wenn keine Angaben gemacht werden, wird stattdessen ein prozentuales Auffüllen verwendet.

fit.objectSize
Enum
small, medium, large

Sie können eine synthetische Größe für Ihr Motiv angeben. Dies ist besonders nützlich beim eCommerce, um dem Käufer eine ungefähre Vorstellung der Größe des Produkts in Beziehung zu anderen Produkten zu vermitteln.

Standardeinstellung: large (= die Größe des Ergebnisses wird nicht angepasst)

fit.verticalAlignment
Enum
top, middle, bottom

Gibt an, wie Ihr Ergebnis ausgerichtet werden soll, wenn überschüssiger vertikaler Raum vorhanden ist.

Gilt auch dann, wenn der überschüssige Raum wegen der Erzwingung des Seitenverhältnisses oder der Zielgröße verteilt wird.

Standardeinstellung: middle

fit.shadows
Enum
ignore, pad, tight

Sie können die Schatten ignorieren, gleichmäßig auf beiden Seiten in Anpassung an die Schatten auffüllen oder so eng auffüllen, dass eine Auffüllung an den relevanten Stellen hinzugefügt wird, um das Abschneiden des Schattens zu vermeiden.

Standardeinstellung: pad

fit.rotationDeg
Gleitkomma
-360.0 bis 360.0

Dreht das Bild. Positive Werte bedeuten gegen den Uhrzeigersinn.

Standardeinstellung: 0

Steuern Sie Ergebnisgröße und Seitenverhältnis:

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

Stellt sicher, dass das Ergebnis über das angegebene Seitenverhältnis verfügt.

fit.verticalAlignment steuert, wie überschüssiger vertikaler Raum verteilt wird.

Standardeinstellung: nicht angewendet

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

Stellt sicher, dass das Ergebnis die angegebene Größe hat.

fit.verticalAlignment steuert, wie überschüssiger vertikaler Raum verteilt wird.

Standardeinstellung: nicht angewendet

result.allowEnlarging
Boolesch
true, false

Steuert, ob das Ergebnis größer als das Eingabebild werden darf oder nicht.

Standardeinstellung: false

Steuern Sie die Ausgabeoptionen:

output.dpi
Ganzzahl
1 bis 4000

Legt die im Ergebnis eingebetteten DPI-Informationen fest.

DPI-Informationen sind nicht enthalten, wenn das Ergebnis weboptimiert ist.

Standardeinstellung: 72

output.colorSpace
Enum
sRGB, AdobeRGB, AppleRGB, ColorMatchRGB

Legt die im Ergebnis eingebetteten Farbrauminformationen fest.

Farbrauminformationen sind nicht enthalten, wenn das Ergebnis weboptimiert ist.

Standardeinstellung: sRGB

output.jpegQuality
Ganzzahl
1 bis 100

Konfiguriert die beim Erstellen eines JPEG-Ergebnisses verwendete Qualitätseinstellung.

Standardeinstellung: 75

output.pngOptimization
Enum
none, lossless, lossy

Konfiguriert die Weboptimierung der PNG-Ergebnisse.

Standardeinstellung: lossless

output.jpegOptimization
Enum
none, enabled

Konfiguriert die Weboptimierung der JPEG-Ergebnisse.

Standardeinstellung: enabled

output.opaqueFileFormat
Enum
jpeg, png

Konfiguriert das für undurchsichtige Ergebnisse zu verwendende Dateiformat.

Standardeinstellung: jpeg

Sie können Bilder ohne Abonnement im Testmodus hochladen. Uploads kosten zwar keine Punkte, aber Sie benötigen dennoch ein gültiges API-Abonnement, um Produktionsbilder über die API hochzuladen.

Probieren Sie es


Format: '#RRGGBB'



Format: '#RRGGBB'

Format: '#RRGGBB'


Format: '[xOffsetPx:int] [yOffsetPx:int] [blurRadiusPx:int, 0 to 75] [opacity:float, 0 to 1]'
Beispiel: 30 30 25 0.75

Format: '[yOffsetPx:int, 0 to 400] [heightPx:int, 0 to 800] [opacity:float, 0 to 1]'
Beispiel: 0 200 0.5




Format: '[width:float, >0]:[height:float, >0]'
Beispiel: 4:3

Format: '[width:int, >0] [height:int, >0]'
Beispiel: 400 300

Username = API Id, Password = API Key

cURL

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

Geht davon aus, dass 'example.jpg' vorhanden ist. Nach Bedarf ersetzen. Die Zeile mit 'test=true' ist optional.

Beispiel einer Antwort

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

Herunterladen GET https://clippingmagic.com/api/v1/images/[imageId]

Zum Herunterladen eines Ergebnisses verwenden Sie eine standardmäßige HTTP GET-Anfragemethode. Es muss zuerst ein Ergebnis erstellt worden sein.

Die Testergebnisse können kostenlos heruntergeladen werden, enthalten allerdings ein Wasserzeichen. Die Produktionsergebnisse kosten beim ersten Herunterladen jeweils einen Punkt; wiederholte Downloads sind kostenlos.

Wenn kein Ergebnis zur Verfügung steht, erhalten Sie eine Fehlerantwort.

Parameter

imageId

In die URL integriert

Sie müssen den id-Wert einfügen, der im Upload-Aufruf zurückgegeben wurde.

Optional
format

format=result (Standardeinstellung) ruft das Ergebnisbild ab.

format=clipping_path_svg ruft stattdessen den Clipping-Pfad (SVG) ab.

format=alpha_mask_png ruft stattdessen die Alphamaske (PNG) ab.

format=json ruft stattdessen das Bild-JSON-Objekt ab. Dies ist dann nützlich, wenn Sie die resultRevision prüfen möchten oder wenn der geheime Schlüssel des Bildes verloren gegangen ist.

Beim Abruf des Bild-JSON-Objekts wird Ihr Konto nicht belastet; Ihnen werden nur heruntergeladene Produktionsergebnisse in Rechnung gestellt.

Antwort-Kopfzeilen

Wenn format nicht json ist, geben wir in diesen HTTP-Antwortkopfzeilen wichtige Informationen an

x-amz-meta-id
Example: 2345

Die id Ihres Bildes.

x-amz-meta-secret
Example: image_secret

Die secret Ihres Bildes.

x-amz-meta-resultrevision
Example: 1

Die resultRevision, die Sie in dieser Anfrage abrufen.

Jedes Mal, wenn ein neues Ergebnis generiert wird, wird dieser Zähler inkrementiert.

x-amz-meta-width
Example: 3200
(nur eingeschlossen für format=result)

Die Breite des Ergebnisses, das Sie in dieser Anfrage abrufen, in Pixeln.

x-amz-meta-height
Example: 2400
(nur eingeschlossen für format=result)

Die Höhe des Ergebnisses, das Sie in dieser Anfrage abrufen, in Pixeln.

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

Der Dateiname des Ergebnisses, einschließlich Erweiterung.

Username = API Id, Password = API Key

cURL

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

Beispiel für eine JSON-Antwort

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

Liste GET https://clippingmagic.com/api/v1/images

Um eine Liste Ihrer Bild-JSON-Objekte herunterzuladen, verwenden Sie eine standardmäßige HTTP GET-Anfragemethode.

Parameter

Optional
limit

Anzahl der abzurufenden Datensätze. Der Standardwert betrögt 20 (Min 1, Max 100).

Optional
offset

In der Liste der Datensätze zu verwendender Offset-Wert (Standardeinstellung 0).

Antwortattribute

images

Ein Array mit Bild-JSON-Objekten.

limit

Das beim Erstellen des Ergebnisses tatsächlich verwendete limit.

offset

Das beim Erstellen des Ergebnisses tatsächlich verwendete offset.

Username = API Id, Password = API Key

cURL

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

Beispiel einer Antwort

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

Löschen POST https://clippingmagic.com/api/v1/images/[imageId]/delete

Zum Löschen eines Bildes verwenden Sie eine standardmäßige HTTP POST-Anfrage, die an die entsprechende URL geleitet wird.

Damit wird geringfügig von standardmäßigen REST-Praktiken abgewichen, um der Tatsache Rechnung zu tragen, dass zahlreiche HTTP-Client-Bibliotheken das HTTP DELETE-Verb nicht unterstützen. Gleichzeitig wird vermieden, dass mehrere Methoden zur Durchführung einer Aktion bereitgestellt werden.

Parameter

imageId

In die URL integriert

Sie müssen den id-Wert einfügen, der im Upload-Aufruf zurückgegeben wurde.

Antwortattribute

image

Das gelöschte Bild-JSON-Objekt.

Probieren Sie es

Username = API Id, Password = API Key

cURL

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

Beispiel einer Antwort

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

Konto GET https://clippingmagic.com/api/v1/account

Rufen Sie allgemeine Informationen über Ihr Konto auf, beispielsweise Abonnementstatus und Anzahl der verbliebenen Punkte.

Parameter

Keine

Antwortattribute

subscriptionPlan

Der Plan, den Sie derzeit abonniert haben, bzw. „Keine“.

subscriptionState

Der Status Ihres aktuellen Abonnements („aktiv“ oder „überfällig“) oder „abgelaufen“, wenn kein Abonnement vorliegt.

credits

Die Anzahl der in Ihrem Konto verbliebenen Punkte. Ist 0, wenn derzeit kein Abonnement vorliegt.

Username = API Id, Password = API Key

cURL

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

Beispiel einer Antwort

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