Unter Settings → Developer findest du alles für die Bluepic API: deine API-Keys, den Explorer zum Testen von Anfragen und die API-Referenz. Jeder Account kann den Developer-Bereich nutzen, mit oder ohne Team. Wie du für ein Template eine Bild-URL oder eine API-Anfrage erzeugst, steht in Automate: Bilder per URL und API erzeugen.
Oben wechselst du zwischen den Tabs Keys und Explorer. Reference oben rechts öffnet die Dokumentation.
Keys
Einen neuen Key erstellst du so:
- Klicke auf New API key. Ein Popup öffnet sich.
- Gib bei Label einen Namen ein, zum Beispiel den Namen deiner Integration.
- Klicke auf Create. Der neue Key erscheint in der Liste.
Nutze für jede Integration einen eigenen Key. Dann kannst du einen abschalten, ohne dass die anderen ausfallen. Die Liste zeigt für jeden Key:
- Key: den Namen, wann er erstellt und zuletzt genutzt wurde.
- Secret: den Key selbst. Mit dem Symbol mit den zwei Blättern in der Zeile kopierst du ihn jederzeit.
- Webhook signing secret: steht unter jedem aktiven Key. Du brauchst es nur, um zu prüfen, ob eine Webhook-Nachricht wirklich von Bluepic kommt.
- Status: active oder revoked.
- ×: widerruft den Key nach einer Bestätigung. Ab dann bekommt jedes System, das ihn nutzt, einen
401-Fehler. Der Key bleibt als revoked in der Liste. Du kannst ihn nicht wieder einschalten.
Sende den Key als Authorization: Bearer bp_live_… an https://api.bluepic.io/v1. Bewahre Keys auf deinem Server oder in Umgebungsvariablen auf, nie in öffentlichem Browsercode oder in einem Code-Repository.
Keys im Team
- Ein Key handelt für den Bereich, in dem die Person, die ihn erstellt hat, gerade ist: für ihr Team oder, ohne Team, für ihren persönlichen Account. Verlässt du das Team, handeln deine Keys ab dann für deinen persönlichen Account, nicht mehr für das Team.
- Renderings werden dem Besitzer des Templates berechnet: dem Team, wenn das Template dem Team gehört, sonst dem persönlichen Account.
- Im Team zählen die Renderings aller Keys zum Rate Limit des Teams.
- Anfragen zur Teamverwaltung, etwa Mitglieder einladen oder entfernen, funktionieren nur, wenn du Owner oder Admin bist. Deine Rolle wird bei jeder Anfrage geprüft. Verlierst du diese Rechte, verliert sie auch der Key.
- Die Liste unter Keys zeigt nur die Keys, die du selbst erstellt hast.
Explorer
Im Tab Explorer baust du Anfragen an die API zusammen und sendest sie. Beim Öffnen ist der Render-Endpunkt ausgewählt.
- Links die Liste der Endpunkte: Hier wählst du einen anderen Endpunkt. Search endpoints filtert die Liste.
- Path, Query, Body: die Felder der Anfrage. Pflichtfelder haben ein
*. Das Info-Symbol neben einem Feld erklärt es. templateId: Wählst du eines deiner Templates, zeigt der Explorer untercanvasseine Canvases und unterdataseine Input-Felder, ausgefüllt mit den Standardwerten. Default canvas rendert den Standard-Canvas.- Oben rechts die Auswahl, womit die Anfrage gesendet wird: mit einem deiner aktiven Keys oder mit Studio session, also deinem Studio-Login. Widerrufene Keys stehen nicht zur Auswahl. Daneben zeigt ein Tag, wie viele Renderings du in dieser Minute noch übrig hast, zum Beispiel 87/100 renders this minute.
- Send: sendet eine echte Anfrage. Ein Rendering verbraucht Credits und zählt zum Rate Limit, egal ob mit Key oder Studio session.
- Debug (free): zeigt die Render-Anfrage als JSON, so wie die API sie verarbeiten würde. Es wird nichts gerendert und nichts berechnet. Die Anfrage zählt aber zum Rate Limit.
- Rechts die Antwort mit Status, Dauer und Größe: Ein Bild erscheint als Vorschau, ein Video als Player mit seinen Fortschrittsmeldungen, andere Dateien mit einem Button Download, JSON als formatierter Text. Ein Fehler zeigt Code und Meldung. Hast du Eingabenamen verwendet, die das Template nicht kennt, siehst du die richtigen.
- cURL, fetch (JS), Python: dieselbe Anfrage als Code unter der Anfrage. Dein Key steht nie darin. Der Code liest ihn aus der Umgebungsvariable
BLUEPIC_API_KEY.
Aus Automate im Template-Editor öffnest du mit Open in Explorer den Explorer in einem neuen Browser-Tab, mit dem Template schon ausgewählt.
Rate Limit
Render-Anfragen an POST /v1/renders sind pro Minute begrenzt:
- 100 pro Minute für ein Team,
- 10 pro Minute für einen Account ohne Team.
Das Limit gilt für das ganze Team, nicht pro Key. Ein weiterer Key erhöht es also nicht. Ist das Limit erreicht, antwortet die API mit 429 und sagt dir, wann du es wieder versuchen kannst. Jede Render-Antwort enthält die Header X-RateLimit-Limit, X-RateLimit-Remaining und X-RateLimit-Reset. Damit kann deine Integration langsamer werden, bevor sie das Limit erreicht.
Referenz
Reference oben rechts öffnet die vollständige API-Dokumentation in einem neuen Tab unter https://api.bluepic.io/v1/docs. Sie listet alle Endpunkte mit ihren Parametern und Antworten. Du musst dich dafür nicht einloggen. Der Explorer nutzt dieselbe API-Beschreibung, neue Endpunkte erscheinen also auch dort.