Client API

Wenn diese Übersetzung von der englischen Version abweicht, gilt die englische Version.

Die Client-API ist ein lokaler Dienst innerhalb der App für erweiterte Automatisierung. Es handelt sich nicht um die öffentliche Cloud-API und sollte nicht für nicht vertrauenswürdige Netzwerke zugänglich gemacht werden.

Typische Verwendungen

Verwenden Sie die lokale API, wenn Sie möchten, dass ein vertrauenswürdiges Skript oder lokales Tool Folgendes tun soll:

• Trigger-Deck-Synchronisierung;
• Cloud- oder lokale Decks auflisten;
• ein Deck erstellen;
• ein Deck aus der Cloud holen;
• Deck-Metadaten aktualisieren;
• ein lokales Deck löschen;
• Kategorien auflisten;
• Karten erstellen, aktualisieren, suchen oder löschen;
• Deck-Ressourcen hochladen oder löschen;
• Integrieren Sie Cardary in einen persönlichen Arbeitsablauf.

Authentifizierung

Geschützte Endpunkte erfordern den Anmeldestatus der App und ein lokales Geheimnis über Folgendes:

• der „X-API-SECRET“-Header; oder
• der „geheime“ Abfrageparameter.

Behandeln Sie das Geheimnis wie einen Ausweis. Fügen Sie es nicht in öffentliche Protokolle, den Browserverlauf, freigegebene Skripts oder Remote-Dienste ein.

Endpunktgruppen

Die App enthält Endpunktgruppen für:

Gruppe	Zweck
Authentifizierung	Überprüfen Sie die Anmeldung und den Zugriffsstatus der lokalen API.
Synchronisieren	Lösen Sie die Deck-Synchronisierung aus oder überprüfen Sie sie.
Decks	Decks auflisten, erstellen, abrufen, aktualisieren und löschen.
Kategorien	Lesen Sie die Struktur der Deck-Kategorie.
Karten	Suchen, erstellen, aktualisieren und löschen Sie Karteninhalte.
Ressourcen	Von Karten verwendete Medien oder Dateien hochladen und löschen.

Die genauen Nutzlastformen können sich je nach App-Version ändern. Überprüfen Sie die App-Implementierung, wenn Sie eine strikte Integration erstellen.

Sicherheitsregeln

• Verwenden Sie die API nur auf vertrauenswürdigen Computern.
• Binden Sie es nicht an öffentliche Netzwerke.
• Geben Sie das lokale Geheimnis nicht weiter.
• Testen Sie es zuerst mit einem kleinen Deck.
• Synchronisieren Sie vor und nach großen automatisierten Änderungen.
• Sichern oder exportieren Sie wichtige Decks vor Massenaktualisierungen.
• Vermeiden Sie gleichzeitige Bearbeitungen über die Benutzeroberfläche und ein Skript, es sei denn, Sie verstehen das Synchronisierungsverhalten.

Automatisierungsmuster

Gute Kandidaten:

• Erstellen Sie ein Deck aus einer lokalen Datenpipeline.
• Karten aus einem überprüften CSV-Export aktualisieren;
• generierte Bilder oder Audiodateien anhängen;
• Synchronisierung nach einem kontrollierten Import auslösen;
• Suchkarten für lokale Qualitätsprüfungen.

Riskante Kandidaten:

• Löschen großer Kartensätze ohne Backup;
• Umschreiben von Feldern in einem Deck ohne Vorschau;
• Hochladen ungeprüfter KI-Ausgaben;
• Ausführen von Skripten, während ein anderes Gerät dasselbe Deck bearbeitet;
• Offenlegung der API über einen Remote-Server.

Fehlerbehebung

Problem	Was ist zu überprüfen
Anfrage ist nicht autorisiert	Anmeldestatus und „X-API-SECRET“.
Deck kann nicht bearbeitet werden	Deck-Besitz, schreibgeschützter Status und Deck-Typ-Kompatibilität.
Hochladen der Ressource schlägt fehl	Plus Anhangsbeschränkungen, Dateipfad, Größe und Netzwerk.
Sync aktualisiert kein anderes Gerät	Führen Sie die Synchronisierung auf beiden Geräten aus und warten Sie auf Ressourcen.
Nutzlastfehler	Vergleichen Sie Ihre Anfrage mit der aktuellen App-Implementierung.

Verwandte Themen: Konto & Synchronisierung und Karten importieren.