Entwicklerhandbuch

Dieses Handbuch ist für Entwickler, deren Software OpenBot nutzt oder erweitert. API-Zugriff gibt keine zusätzlichen Rechte. Jede Anfrage handelt weiterhin für ihren Aufrufer.

Einen Client verbinden

Du brauchst eine OpenBot-Adresse und ein Konto in einer Organisation. Nutze den lokalen API-Schnellstart, wenn du einen Testserver brauchst.

1. Baue Anmeldung, Organisationswahl und Tokens ein.
2. Nutze den TypeScript-Client oder die HTTP-Referenz.
3. Sende Bot-Nachrichten, lies Chat-Ergebnisse und Streams und bearbeite Anfragen.
4. Ergänze Dateien, Apps oder Live-Sitzungen nach Bedarf.

Die API-Anleitungen in der Seitenleiste beschreiben Felder, Antwortzustände und Fehler. Der Client stellt seine eigenen Ansichten und Rückkehrpfade bereit.

Eine App veröffentlichen

Du brauchst die Kontrolle über den App-Dienst und seine öffentliche HTTPS-Adresse.

1. Veröffentliche die Dokumente nach dem App Protocol.
2. Prüfe sie mit dem Protokoll-Testdienst.
3. Nutze die Werkzeuge für Herausgeber, um Kontrolle nachzuweisen, Verbindungen zu testen und Aufnahme in den Index anzufragen.
4. Lies den App-Index-Vertrag zu Suche und Rückzug.

An OpenBot arbeiten

1. Lies Mitwirken für Einrichtung, Prüfungen und Projektregeln.
2. Lies die Paketgrenzen und den Ausführungsentwurf.
3. Nutze Aus Code starten für den Serveraufbau. Ergänze dort Model-Backends, Live-Backends oder Logger.
4. Folge bei Projektveröffentlichungen den Schritten zur Veröffentlichung und Prüfung.

Installation und Geheimnisse im Produktivbetrieb gehören ins Administrationshandbuch.