REST-API und MCP-Server
Kanalyo – YJAR Social OS, YJAR GmbH · Stand 14.10.2026
Überblick
Kanalyo hat eine REST-API unter https://app.kanalyo.com/api/v1 und einen MCP-Server (Model Context Protocol, Streamable HTTP) unter https://app.kanalyo.com/api/mcp. Beide nutzen dieselben Werkzeuge. Damit können eigene Programme und Assistenten, die MCP unterstützen, mit Ihrem Konto arbeiten: Kanäle, Beiträge, Kalender und Kennzahlen lesen, Entwürfe und Ideen anlegen und Beiträge intern kommentieren. Voraussetzung ist ein Kanalyo-Konto und ein persönlicher Schlüssel.
Die maschinenlesbare Beschreibung (OpenAPI) ist öffentlich abrufbar: https://app.kanalyo.com/api/v1/openapi.json.
Was die Schnittstelle nicht kann
Über einen Schlüssel lässt sich nichts freigeben, nichts veröffentlichen und nichts löschen. Entwürfe entstehen immer im Status „Entwurf“ und warten in Kanalyo auf einen Menschen. Unbekannte Felder (etwa ein Status bei einem neuen Entwurf) werden mit 400 abgelehnt. Nicht möglich ist:
- Beiträge freigeben
- Beiträge veröffentlichen oder einen Veröffentlichungstermin auslösen (ein Termin ist nur ein Vorschlag)
- Beiträge, Kanäle, Medien oder Ideen löschen
- Kanäle verbinden oder trennen, Zugangsdaten auslesen (Kanallisten enthalten nie Tokens)
Bereiche
Ein Schlüssel bekommt beim Erstellen einen oder mehrere Bereiche. Wirksam ist immer der Schnitt aus den Bereichen des Schlüssels und Ihrer aktuellen Rolle, je Arbeitsbereich: Ein Schlüssel hat nie mehr Rechte als Sie. Wer aus dem Konto entfernt oder herabgestuft wird, verliert sofort auch die Rechte seiner Schlüssel. Im Lesemodus (Testphase abgelaufen, Abo beendet) gilt nur „Lesen“.
| Bereich | Erlaubt | Rollen |
|---|---|---|
Lesen (read) | Kanäle, Beiträge, Kalender, Kennzahlen, Ideen und Medienliste ansehen | alle Rollen |
Entwürfe (draft) | Entwürfe und Ideen anlegen, eigene Entwürfe ändern (nie freigeben oder veröffentlichen) | Owner, Admin, Editor |
Kommentare (comment) | Beiträge intern kommentieren | Owner, Admin, Editor, Client Approver |
Werkzeuge und Endpunkte
| Werkzeug (MCP) | REST | Bereich | Zweck |
|---|---|---|---|
list_workspaces | GET /api/v1/workspaces | read | Arbeitsbereiche auflisten |
list_channels | GET /api/v1/channels | read | Kanäle auflisten |
list_posts | GET /api/v1/posts | read | Beiträge auflisten |
get_post | GET /api/v1/posts/{id} | read | Beitrag lesen |
create_draft | POST /api/v1/drafts | draft | Entwurf anlegen |
update_draft | PATCH /api/v1/drafts/{id} | draft | Entwurf ändern |
add_comment | POST /api/v1/posts/{postId}/comments | comment | Beitrag kommentieren |
list_ideas | GET /api/v1/ideas | read | Ideen auflisten |
create_idea | POST /api/v1/ideas | draft | Idee anlegen |
get_calendar | GET /api/v1/calendar | read | Kalender lesen |
get_metrics | GET /api/v1/metrics | read | Kennzahlen lesen |
list_media | GET /api/v1/media | read | Medien auflisten |
Typischer Ablauf für einen Entwurf: list_workspaces, dann list_channels (Kanal-IDs), dann create_draft. Hat ein Text eine KI mitgeschrieben, setzen Sie aiGenerated: true; die Kennzeichnung prüft anschließend das Team in Kanalyo. get_metrics liefert nur, was Kanalyo wirklich weiß (veröffentlichte Beiträge), keine geschätzten Reichweiten.
Schlüssel erstellen
- In Kanalyo anmelden und im Kundenportal den Abschnitt API-Zugang für KI-Assistenten und eigene Werkzeuge öffnen.
- Namen vergeben (z. B. „Mein Assistent“), Bereiche wählen und optional ein Ablaufdatum setzen (höchstens 730 Tage). Je Person sind höchstens 20 aktive Schlüssel möglich.
- Schlüssel erstellen. Der Schlüssel beginnt mit
kly_und wird nur jetzt vollständig angezeigt: sofort kopieren und sicher ablegen (Passwortmanager). Kanalyo speichert nur einen nicht umkehrbaren Prüfwert und kann den Schlüssel nicht erneut zeigen.
Assistenten einrichten
Die Bedienung unterscheidet sich je nach Assistent. Gebraucht werden immer dieselben Angaben:
| Angabe | Wert |
|---|---|
| Art des Servers | MCP über HTTP („Streamable HTTP“, entfernter Server) |
| Adresse | https://app.kanalyo.com/api/mcp |
| Anmeldung | Header Authorization: Bearer kly_DEIN_SCHLUESSEL |
Viele Assistenten lesen eine Konfigurationsdatei in diesem Format. Ersetzen Sie den Platzhalter durch Ihren eigenen Schlüssel, am besten über eine Umgebungsvariable oder den Geheimnisspeicher des Assistenten, nicht im Klartext in einer Datei, die Sie teilen oder versionieren:
{
"mcpServers": {
"kanalyo": {
"type": "http",
"url": "https://app.kanalyo.com/api/mcp",
"headers": {
"Authorization": "Bearer kly_DEIN_SCHLUESSEL"
}
}
}
}Ob die Verbindung steht, zeigt der Assistent meist als Liste der Werkzeuge. Zum Testen von Hand (der Schlüssel steht in der Umgebungsvariable KANALYO_KEY):
curl -s https://app.kanalyo.com/api/mcp \
-H "Authorization: Bearer $KANALYO_KEY" -H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'Die REST-API nutzt denselben Header, zum Beispiel:
curl -s https://app.kanalyo.com/api/v1/workspaces \
-H "Authorization: Bearer $KANALYO_KEY"Grenzen und Schutz
- Höchstens 60 Aufrufe je Minute und 5.000 je Tag und Schlüssel; darüber antwortet die Schnittstelle mit
429und dem HeaderRetry-After. - Der Zugang gilt nur für den Mandanten, für den der Schlüssel erstellt wurde, und nur für Arbeitsbereiche, in denen Sie Mitglied sind. Wer mehrere Konten hat, erstellt je Konto einen eigenen Schlüssel.
- Jeder schreibende Aufruf wird mit Ihrer E-Mail-Adresse und dem Schlüssel-Präfix im Protokoll festgehalten; in der Liste im Kundenportal sehen Sie „zuletzt benutzt“.
- Die Verbindung läuft ausschließlich über HTTPS. Anmeldung ist nur der Schlüssel im Header: Cookies, Origin und andere Kopfzeilen spielen für diese Routen keine Rolle.
- Behandeln Sie den Schlüssel wie ein Passwort und vergeben Sie einen Schlüssel je Assistent oder Programm, mit sprechendem Namen und möglichst mit Ablaufdatum. Bei Verdacht auf Verlust oder Missbrauch im Kundenportal sofort Widerrufen: Das wirkt unmittelbar.
- Ein Assistent liest Texte aus Ihrem Konto und kann durch fremde Inhalte (etwa Kommentare) beeinflusst werden. Deshalb kann er nichts veröffentlichen oder löschen. Prüfen Sie angelegte Entwürfe, bevor Sie sie freigeben.
Fehlerbilder
| Status | Ursache |
|---|---|
401 | Schlüssel fehlt, ist ungültig, widerrufen oder abgelaufen. |
403 | Der Schlüssel oder Ihre Rolle deckt den Bereich nicht ab. |
404 | Arbeitsbereich oder Beitrag nicht gefunden oder kein Zugriff. |
409 | Der Beitrag ist kein eigener Entwurf mehr oder wurde gleichzeitig geändert. |
429 | Ratenbegrenzung erreicht; der Header Retry-After nennt die Wartezeit. |
Weitere Informationen
Welche Daten Kanalyo in der Schnittstelle verarbeitet, regeln die Datenschutzerklärung und der Auftragsverarbeitungsvertrag; zu den Schutzmaßnahmen siehe Sicherheit. Fragen zur Schnittstelle: Hilfe und Kontakt.