Ausweisfoto-Ersteller API
PixMiller REST API · v1
Senden Sie ein Portrait; die API entfernt den Hintergrund des Portraits, tauscht ihn gegen eine Standard-Ausweis-Hintergrundfarbe und schneidet auf die gewünschte Spezifikation zu.
Dieser Endpunkt ist in der Vorschau — die Route und Parameter werden finalisiert und können sich vor dem Start ändern. Konventionen (X-Api-Key-Auth, JSON-Antwort) entsprechen der Live-Hintergrundentfernungs-API.
POST
https://api.pixmiller.com/v1/id-photo
1
Authentifizierung & Anfrage
Senden Sie Ihren geheimen Schlüssel im
X-Api-Key: YOUR_API_KEY Anfrage-Header. Erstellen und verwalten Sie Schlüssel auf Ihrer Kontoseite.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
image_file
|
file | erforderlich | Portraitfoto — frontal, gleichmäßig beleuchtet |
spec
|
string | erforderlich | Spezifikation: 1inch / 2inch / us_passport / cn_visa … |
bg_color
|
string | optional | Hintergrund: white (Standard) / blue (blau) / red (rot) |
2
Code-Beispiele
Wählen Sie eine Sprache und kopieren Sie — funktioniert sofort.1curl -X POST "https://api.pixmiller.com/v1/id-photo" \2 -H "X-Api-Key: YOUR_API_KEY" \3 -F "[email protected]" \4 -F "spec=1inch" \5 -F "bg_color=blue"
1import requests23resp = requests.post(4 "https://api.pixmiller.com/v1/id-photo",5 headers={"X-Api-Key": "YOUR_API_KEY"},6 files={"image_file": open("face.jpg", "rb")},7 data={"spec": "1inch", "bg_color": "blue"},8)9print(resp.json()["url"])
1import fs from "node:fs";23const form = new FormData();4form.append("image_file", new Blob([fs.readFileSync("face.jpg")]), "face.jpg");5form.append("spec", "1inch");6form.append("bg_color", "blue");7const resp = await fetch("https://api.pixmiller.com/v1/id-photo", {8 method: "POST",9 headers: { "X-Api-Key": "YOUR_API_KEY" },10 body: form,11});12console.log((await resp.json()).url);
3
Antwort
1{2 "url": "https://cdn.pixmiller.com/result/8Kd2pQ.png"3}
url
Temporäre URL des verarbeiteten Bildes (das zugrunde liegende Bild wird nach 3 Tagen automatisch gelöscht).
4
Fehler
Fehler geben den passenden Statuscode und einen JSON-Body zurück in der Form {"errors":{"code":"…","message":"…"}}.
400
validation error
Fehlende oder ungültige image_file, Datei zu groß, oder widersprüchliche Bildquellen.
401
authentication_failed
Der X-Api-Key-Header fehlt oder ist ungültig.
402
not_enough_credit
size=full wurde angefordert, aber das Konto hat keine HD-Credits mehr.
422
invalid_image
Das Bild konnte nicht verarbeitet werden — zu klein, nicht unterstützt, oder Dekodierung fehlgeschlagen.
429
throttled
Ratenlimit überschritten. Verlangsamen und nach dem Retry-After-Header erneut versuchen.