Manchmal möchte jemand etwas an Stippa anbinden. Ein Webdesigner, der das Buchungsformular im Erscheinungsbild Ihres Betriebs nachbauen will, ein Buchhalter mit einem Skript, das Umsätze abruft, oder ein Dienst wie Zapier, der eine Nachricht schickt, sobald ein Termin hereinkommt. So jemand bittet Sie dann um einen API-Schlüssel.
Diese Seite ist für Sie, nicht für den Entwickler. Sie müssen nicht wissen, wie es technisch funktioniert, um die richtige Entscheidung zu treffen. Was der Entwickler braucht, steht in der Entwicklerdokumentation, die auf Englisch ist.
Was ist ein API-Schlüssel?
Ein langer, geheimer Text, der mit stp_live_ beginnt. Wer ihn hat, darf im Namen Ihres Betriebs
genau die Dinge tun, die Sie beim Erstellen angehakt haben, und nichts anderes.
Drei Dinge sind wichtiger als die Technik:
- Ein Schlüssel gehört zu Ihrem Betrieb. Er kommt nie an die Daten eines anderen Betriebs, auch nicht aus Versehen.
- Ein Schlüssel ist keine Anmeldung. Es hängt kein Passwort daran, und niemand kann damit in die App gelangen. Er funktioniert nur für die Anbindung selbst.
- Ein Schlüssel ist ein Geheimnis, wie der Schlüssel zu Ihrem Geschäft. Wer ihn hat, kann ihn benutzen. Genau deshalb gibt es den Rest dieser Seite.
Wann brauche ich einen?
Nur wenn jemand danach fragt. Für die normale Nutzung von Stippa brauchen Sie nie einen API-Schlüssel: Das Buchungswidget, der Kalender, die E-Mails und das öffentliche Profil funktionieren alle ohne.
Typische Fälle, in denen es doch eine Rolle spielt:
- Ihr Webdesigner möchte das Buchen vollständig in Ihre eigene Website einbauen, statt das Standard-Widget zu verwenden.
- Jemand möchte Ihre Termine automatisch in eine Tabelle oder ein Buchhaltungsprogramm übertragen.
- Sie möchten eine Benachrichtigung in Slack, Teams oder Zapier, sobald gebucht wird.
Welchen Plan brauche ich?
| Was Sie möchten | Ab |
|---|---|
| Daten auslesen (Termine, Kunden, Dienstleistungen, Verfügbarkeit) | Groei |
| Daten anlegen oder ändern lassen, und Webhooks | Pro |
Wechseln Sie zu einem niedrigeren Plan, bleibt der Schlüssel einfach bestehen. Die Rechte, die Ihr Plan nicht mehr umfasst, funktionieren nur nicht mehr. Upgraden Sie später wieder, funktioniert die Anbindung sofort wieder, ohne dass jemand etwas einstellen muss.
Einen Schlüssel erstellen
Sie finden die Schlüssel in der Dev-App, die links oben in der App-Auswahl erscheint, sobald Sie das Modul API-Zugang aktiviert haben.
Schalten Sie das Modul ein
Gehen Sie zu Verwaltung > Module und schalten Sie API-Zugang ein. Die Dev-App erscheint danach in der App-Auswahl.
Gehen Sie zu Dev > Schlüssel
Klicken Sie auf Neuer Schlüssel.
Geben Sie ihm einen Namen, den Sie in einem Jahr noch verstehen
Nicht „Test" oder „Schlüssel 2", sondern „Website Jansen Webdesign" oder „Anbindung Buchhaltung". Wenn Sie jemals etwas widerrufen müssen, ist der Name das Einzige, woran Sie erkennen, welcher Schlüssel wem gehört.
Haken Sie nur an, was nötig ist
Es stehen feste Kombinationen bereit. Im Zweifel wählen Sie Nur lesen: Damit lässt sich nichts ändern. Rechte hinzufügen geht später nicht mehr, einen zweiten Schlüssel erstellen aber schon, und das ist die sichere Reihenfolge.
Kopieren Sie den Schlüssel sofort
Sie sehen den vollständigen Schlüssel ein einziges Mal, direkt nach dem Erstellen. Danach speichert Stippa nur noch eine verschlüsselte Form, und auch wir können ihn nicht mehr anzeigen. Haben Sie ihn verloren, widerrufen Sie ihn und erstellen einen neuen.
Jedes Mal, wenn ein Schlüssel erstellt wird, erhält die E-Mail-Adresse Ihres Unternehmens eine Nachricht mit dem Namen, den Rechten und wer ihn erstellt hat. Erkennen Sie eine solche E-Mail nicht, widerrufen Sie den Schlüssel sofort. Hat ein Schlüssel ein Ablaufdatum, erhalten Sie 14 und 3 Tage vorher eine Erinnerung, damit Sie rechtzeitig einen neuen erstellen können.
Sie können höchstens 20 aktive Schlüssel gleichzeitig haben.
Einen Schlüssel sicher weitergeben
Den Schlüssel einmal per E-Mail zu schicken und ihn dann zu vergessen, ist der Weg, auf dem es meistens schiefgeht: Ein Postfach bleibt jahrelang durchsuchbar, wird geteilt und geht mit zum nächsten Arbeitgeber.
- Geben Sie ihn über einen Kanal weiter, der Nachrichten löscht, oder über den Passwort-Tresor, den der Entwickler ohnehin benutzt.
- Stellen Sie ihn nie in eine öffentliche Nachricht, ein Ticket oder ein geteiltes Dokument.
- Erstellen Sie für jede Partei einen eigenen Schlüssel. Zwei Firmen mit demselben Schlüssel bedeuten, dass Sie die Anbindung beider lahmlegen, wenn Sie einen widerrufen müssen.
- Bitten Sie um ein Ablaufdatum, wenn der Auftrag befristet ist. Sie können einen Schlüssel ablaufen lassen, und dann muss später niemand mehr daran denken.
Einen Schlüssel widerrufen
Gehen Sie zu Dev > Schlüssel und wählen Sie Widerrufen beim betreffenden Schlüssel. Das wirkt sofort: Die nächste Anfrage mit diesem Schlüssel wird abgelehnt. Widerrufen lässt sich nicht rückgängig machen, die Anbindung braucht danach also einen neuen Schlüssel.
Widerrufen Sie auf jeden Fall:
- wenn die Zusammenarbeit mit dem Entwickler oder der Agentur endet;
- wenn der Schlüssel irgendwo gelandet ist, wo er nicht hingehört;
- wenn Sie nicht mehr wissen, wofür ein Schlüssel da ist. Ein Schlüssel, den niemand zuordnen kann, sollte nicht aktiv sein.
Sind Sie unsicher, ob ein Schlüssel noch benutzt wird, schauen Sie zuerst in Dev > Protokoll. Dort sehen Sie für jede Anfrage, wann etwas hereinkam und ob es geklappt hat. Einen Schlüssel, der dort seit Monaten nicht auftaucht, können Sie beruhigt widerrufen.
Webhooks: die andere Richtung
Ein Schlüssel lässt jemanden Daten bei Ihnen abrufen. Ein Webhook macht das Umgekehrte: Stippa schickt eine Nachricht an eine Webadresse, sobald etwas passiert, zum Beispiel wenn ein Termin gebucht oder storniert wird. Das braucht eine Anbindung an Slack oder Zapier. Webhooks gibt es ab Pro. Schalten Sie dafür unter Verwaltung > Module auch das Modul Webhooks ein, unter API-Zugang. Danach finden Sie sie unter Dev > Webhooks. Sie können höchstens 5 Adressen einrichten.
Eine Webhook-Adresse verdient dieselbe Sorgfalt wie ein Schlüssel. Wählen Sie bei Was wir mitschicken die Option Das vollständige Objekt, schickt Stippa bei jedem Ereignis die zugehörigen Daten an diese Adresse, einschließlich Namen, E-Mail-Adressen und Telefonnummern Ihrer Kunden. Wer die Adresse einstellen darf, kann diesen Datenstrom also woandershin umleiten. Übernehmen Sie nur eine Adresse von jemandem, dem Sie vertrauen, und prüfen Sie die Liste, wenn Sie nicht mehr wissen, wer was eingerichtet hat.
Sollen keine Kundendaten mitgeschickt werden, wählen Sie Nur die ID. Stippa schickt dann nur, was passiert ist und um welchen Termin oder Kunden es geht. Das System auf der anderen Seite ruft den Rest selbst mit einem API-Schlüssel ab.
Bleibt eine Adresse unerreichbar, versucht Stippa es einige Male erneut und schaltet den Endpunkt danach automatisch ab, damit nicht endlos an eine tote Adresse gesendet wird. Sie sehen das als Hinweis über der Liste, mit einer Schaltfläche, um ihn wieder einzuschalten, sobald der Empfänger wieder funktioniert.
Häufige Fragen
Kann sich jemand mit meinem Schlüssel bei Stippa anmelden? Nein. Ein Schlüssel funktioniert nur für die Anbindung und gibt keinen Zugang zur App, zu Ihrem Konto oder zu Ihrem Abonnement.
Kann ein Schlüssel an die Daten eines anderen Betriebs kommen? Nein. Der Schlüssel bestimmt selbst, um welchen Betrieb es geht; es gibt keine Einstellung, mit der Sie einen anderen Betrieb angeben könnten.
Ich sehe die Dev-App nicht. Das Modul API-Zugang ist ausgeschaltet, Ihr Plan liegt unter Groei, oder Sie sind Mitarbeiter. Die App ist für Inhaber und Admins sichtbar.
Mein Entwickler fragt nach Dokumentation. Schicken Sie ihn zur Entwicklerdokumentation. Sie ist auf Englisch und enthält alles, was er braucht, einschließlich Beispielen.