Zrzur Entwickler

Anwendungen und Tokens

Erstelle im Entwicklerportal einen Bot, ändere seine Einstellungen und installiere ihn auf einem Server.

Das brauchst du

Ein Zrzur-Konto. Registriere dich in der App, wenn du keins hast. Bots haben Eigentümer. Ein Konto kann 7 Bots pro Woche erstellen: Jede Erstellung zählt 7 Tage, und Löschen gibt keinen Versuch zurück.

Eine Anwendung erstellen

Eine Anwendung und ihr Bot sind dasselbe: Anwendungs-ID, Bot-ID und Benutzer-ID des Bots sind derselbe Wert.

  1. Öffne das Entwicklerportal. Es bittet dich, dich anzumelden. Du findest es auch unter Einstellungen → Entwicklerportal.
  2. Wähle Neue Anwendung.
  3. Gib einen Benutzernamen für den Bot ein. Lies die Bot-Regeln, schalte den Schalter ein, mit dem du sie akzeptierst, und wähle Erstellen.
  4. Das Token erscheint einmal. Kopiere es jetzt und bewahre es sicher auf: Zrzur speichert nur einen Fingerabdruck und kann es nicht noch einmal zeigen.

Der Tab Übersicht

EinstellungWas sie tut
Öffentlicher BotAn: Jeder mit „Server verwalten“ kann ihn installieren. Aus: nur du; andere bekommen BotIsPrivate
Privilegierte IntentsSchalter für Nachrichteninhalt, Servermitglieder und Präsenz. Jeder Schalter wird sofort gespeichert und gilt ab der nächsten Gateway-Verbindung des Bots. Siehe Intents und wenn ein Intent aus ist
BenutzernameDer Name des Bots
Bot-IDDie ID für Routen unter /applications/{id}/...
Zu einem Server hinzufügenInstalliert den Bot auf einem deiner Server
EinladungslinkEin Link zum Teilen, /bot/<bot id> in der App
Token zurücksetzenErzeugt ein neues Token und verlangt eine Bestätigung deiner Identität. Das alte stoppt sofort
HTTP-InteraktionenBefehle an deiner eigenen Adresse empfangen. Siehe Interaktionen über HTTP
Bot löschenLöscht den Bot endgültig und verlangt eine Bestätigung deiner Identität

Der Tab Befehle

Listet die globalen Befehle des Bots. Du kannst dort eine JSON-Liste einfügen, statt aus dem Code zu registrieren. Siehe Slash-Befehle.

Den Bot auf einem Server installieren

Ein Bot tut nichts, bis er auf einem Server ist. Wer ihn installiert, braucht dort Server verwalten. Um ihm gleich Berechtigungen zu geben, braucht die Person auch Rollen verwalten und jede Berechtigung, die sie gibt.

Der schnellste Weg für deinen eigenen Testserver:

  1. Öffne deine Anwendung, Tab Übersicht, und wähle Zu einem Server hinzufügen.
  2. Wähle den Server.

Um mit bestimmten Berechtigungen zu installieren, oder damit andere ihn installieren:

  1. Öffne deine Anwendung, Tab OAuth2, Bereich URL-Generator.
  2. Hake bot.install und die Berechtigungen an, die der Bot braucht.
  3. Kopiere den Einladungslink und öffne ihn, oder schicke ihn an die Admins des Servers.
  4. Die Person wählt einen Server und bestätigt.

Die Berechtigungen werden zu einer Rolle mit dem Namen des Bots. Zrzur erstellt und verwaltet diese Rolle: Menschen können sie höher setzen, aber nicht löschen, solange der Bot da ist. Fordere nur an, was der Bot nutzt.

Reply to commands     nothing extra
Send messages         SendMessage, ViewChannel (members have these by default)
Moderate              KickMembers, BanMembers, TimeoutMembers, ManageMessages

Der Bot bekommt nur eine Rolle, wenn der Link Berechtigungen enthält. Mit Zu einem Server hinzufügen ist er ein einfaches Mitglied mit den Standardberechtigungen des Servers.

Setze die Rolle des Bots nach dem Installieren über die Mitglieder, die er moderieren soll. Siehe Rang.

Serverlimit und Bestätigung

Ein unbestätigter Bot kann 100 Servern beitreten. Danach schlägt die Installation mit BotNeedsVerification fehl. Über 100 Servern behält er nur die privilegierten Intents, die Zrzur genehmigt hat. Wähle im Tab Übersicht den Bereich Verifizierung und beschreibe den Bot. Dieselbe Anfrage als Aufruf, für den angemeldeten Eigentümer:

curl -X POST "https://api.zrzur.com/bots/YOUR_BOT_ID/verification" \
  -H "x-session-token: YOUR_SESSION_TOKEN" \
  -H "content-type: application/json" \
  -d '{
    "statement": "Keeps notes and warnings for one gaming community.",
    "website": "https://example.com/bot",
    "support": "https://example.com/help",
    "privacy_policy_url": "https://example.com/privacy",
    "terms_of_service_url": "https://example.com/terms",
    "intents": 0
  }'
FeldPflichtBedeutung
statementja20 bis 1000 Zeichen: was der Bot tut, wer ihn nutzt, wie er mit Daten umgeht
websiteneinWebsite oder Dokumentation, https://, bis 200 Zeichen
supportneinWo Benutzer Hilfe finden, https://, bis 200 Zeichen
privacy_policy_urljaDatenschutzerklärung des Bots, https://, bis 200 Zeichen. Wird auch am Bot gespeichert
terms_of_service_urljaNutzungsbedingungen des Bots, https://, bis 200 Zeichen. Werden auch am Bot gespeichert
intentsneinSumme der privilegierten Intents, die der Bot braucht. Die Zustimmung genehmigt sie

Es kann eine Anfrage offen sein, und nach einer Ablehnung kannst du eine Woche später erneut fragen. GET /bots/{target}/verification antwortet mit verified, request samt status (Pending, Approved, Denied oder Revoked) und can_apply_at.

Häufige Fehler

FehlerUrsacheLösung
BotIsPrivateDer Bot ist privat und gehört dir nicht„Öffentlicher Bot“ einschalten
AlreadyInServerDer Bot ist schon daNichts zu tun
MissingPermissionDir fehlt „Server verwalten“ oder „Rollen verwalten“Frage den Servereigentümer
BotNeedsVerification100 Server erreichtBestätigung beantragen
ReachedMaximumBotsDein Konto besitzt zu viele BotsLösche einen ungenutzten Bot
TooManyBotCreations7 Bots in den letzten 7 Tagen erstelltWarte bis resets_at (Millisekunden), oder setze das Token eines vorhandenen Bots zurück

Weiter