Entwickler

API-Schlüssel und Shortcuts verwenden

Verbinden Sie wiederholbare Erfassungs- oder Transkriptions-Workflows, ohne Geheimnisse preiszugeben.

Zielgruppe
Entwickler und Power-User, die Vowise in bestehende Workflows integrieren möchten.
Zeit
18 Minuten
Level
Fortgeschritten

Szenario

Beginne mit dem Workflow, für den dieser Guide gedacht ist, bevor du die Schritte ausführst.

Als Automatisierungsbauer möchte ich eine wiederholbare Möglichkeit, Audio an Vowise zu senden, damit ich Erfassungstools ohne manuelles Hochladen von Dateien verbinden kann.

Sie wissen, wo API-Schlüssel passen, wie Sie die öffentliche Referenz testen und welche Geheimnis-Handhabungsregeln Sie befolgen müssen.

Schritte

1

API-Schlüssel erstellen oder finden

Verwenden Sie die für API-Schlüssel vorgesehene Kontoberfläche. Behandeln Sie den Schlüssel wie ein Geheimnis, nicht wie öffentliches Tutorial-Inhalt.

Der Schlüssel ist außerhalb des Repositorys gespeichert.
Screenshots verbergen oder lassen den Schlüssel aus.
2

Die öffentliche API-Referenz testen

Verwenden Sie `/api-reference`, um die öffentliche Transkriptions- und Wörterbuchanfrage-Struktur zu verstehen, bevor Sie sie in die Automatisierung einfügen.

Sie kennen das Format des Auth-Headers.
Sie wissen, welche Endpunkte öffentlich sind.
3

Den Automatisierungs-Wrapper erstellen

Umschließen Sie die Anfrage in Shortcuts, einem lokalen Skript oder einem serverseitigen Workflow, der den Schlüssel privat halten kann.

Der Workflow gibt den Schlüssel nicht in Protokollen aus.
Fehler sind sichtbar, ohne dass Anmeldeinformationen offengelegt werden.

Details

Geheimnis-Handhabungsregeln

Dokumente können die Anfrage-Struktur lehren, aber Beispiele sollten Platzhalter anstelle echter Geheimnisse, wiederverwendbarer Passwörter oder privater URLs verwenden.

  • Verwenden Sie Platzhalter in Dokumenten und Screenshots.
  • Behalten Sie echte Schlüssel in lokalen Geheimispeichern oder serverseitigen Konfigurationen.
  • Rotieren Sie einen Schlüssel, wenn er in einer öffentlichen Aufzeichnung erscheint.

Verbundene Funktionspfade

Dieses Tutorial sollte nicht enden, ohne den nächsten Schritt zu zeigen. Hier sind passende Folgefunktionen und Workflows.