Apiboo-Dokumentation

DokuErste Schritte

Arbeitsbereiche, Sync & Teams

Arbeitsbereiche und wo sie liegen, Anmeldung, Synchronisierung zwischen Geräten und Arbeit im Team.

Alles, was du in den API-Tools baust, liegt in einem Arbeitsbereich: seine Collections, Umgebungen und Variablen. Ein Arbeitsbereich kann auf diesem Computer bleiben, in deinem Apiboo-Konto liegen, einem Team gehören und in deinem eigenen Git-Repository liegen (siehe Git). Diese Seite erklärt die Arten, wie du sie anlegst und wechselst, was die Anmeldung bringt, wie die Synchronisierung funktioniert und wie du mit einem Team teilst.

Brauchst du ein Konto?

Nein. Apiboo funktioniert auch abgemeldet: Collections, Requests, Umgebungen, Dokumente, Boards, Datenbanken, Terminals und der Vault liegen alle auf diesem Computer. Abgemeldet ist jeder neue Arbeitsbereich ein lokaler.

Ein Konto brauchst du für alles, was über Apiboos Server läuft: Synchronisierung zwischen Geräten und mit der Web-App, Teilen, Teams und Chat. Solange du abgemeldet bist, fehlt Chat in der Leiste, und die Titelleiste zeigt weder Teams noch Benachrichtigungen noch den Sync-Status.

Arten von Arbeitsbereichen

ArtWo er liegtGut für
LokalNur auf diesem Gerät.Arbeit, die deinen Rechner nie verlässt. Funktioniert offline und abgemeldet.
Persönlich (Cloud)In deinem Konto, synchronisiert auf deine anderen Geräte.Deine eigene Arbeit auf mehreren Computern.
TeamIn der Bibliothek eines Teams, geteilt mit seinen Mitgliedern.Collections, die das ganze Team nutzt.
GitEin Ordner auf diesem Gerät, der selbst ein Git-Repository ist.Collections, die neben deinem Code versioniert und mit deinen eigenen Git-Tools committet werden.

Jeder lokale, persönliche oder Team-Arbeitsbereich kann außerdem mit einem GitHub-, GitLab- oder anderen Git-Repository synchronisiert werden. Das verbindest du auf der Git-Seite; siehe Einen Arbeitsbereich verbinden.

Arbeitsbereich wechseln

Beim API-Client und beim Verlauf sitzt die Arbeitsbereichsauswahl links in der Titelleiste. Klick darauf, um die Liste zu öffnen.

Die geöffnete Arbeitsbereichsauswahl mit den Abschnitten Local, Personal (cloud) und Team-Arbeitsbereiche und dem aktiven Arbeitsbereich Bookshop
  • Arbeitsbereiche suchen filtert nach Name oder Art. Mit ↑, ↓ und Enter wählst du einen aus.
  • Die Liste ist in Git, Local, Personal (cloud) und Team-Arbeitsbereiche gegliedert. Unter jedem Namen steht die Art.
  • Der aktive Arbeitsbereich hat einen Punkt. Klick einen anderen an, um zu wechseln.
  • … (Workspace actions) in einer Zeile öffnet ihr Menü.
AktionVerfügbar fürFunktion
Share workspaceAngemeldet, nicht lokalTeilt ihn mit einem Team (siehe Arbeitsbereich mit einem Team teilen).
Open Git pageNicht GitÖffnet die Git-Seite mit diesem Arbeitsbereich ausgewählt, zum Verbinden, Synchronisieren oder Pullen (siehe Git).
Fork workspaceAlleKopiert ihn (siehe Arbeitsbereich forken).
Publish to cloudAngemeldet, lokalKopiert ihn in dein Konto (siehe Lokalen Arbeitsbereich veröffentlichen).
Edit workspaceAlleÄndert Name und Beschreibung.
Delete workspaceAlleLöscht ihn.

Über die Befehlspalette (Strg+K) springst du ebenfalls zu einem Arbeitsbereich.

Arbeitsbereich anlegen

  1. Öffne die Arbeitsbereichsauswahl und klick auf Create new workspace.
  2. Gib den Arbeitsbereichsname ein und, wenn du magst, eine Beschreibung.
  3. Wähl den Speicher:

    • Persönlich (in Cloud gespeichert)
    • Lokal — nur dieses Gerät
    • Team-Workspace, wenn du in einem Team bist. Wähl darunter das Team; der Arbeitsbereich gehört dann von Anfang an dem Team.
  4. Setz den Haken bei Beim Forken Variablen und Umgebungen kopieren, wenn Forks sie mitnehmen sollen.
  5. Klick auf Arbeitsbereich erstellen.

Abgemeldet gibt es keine Speicher-Auswahl: Der Arbeitsbereich wird lokal gespeichert.

Um stattdessen einen Arbeitsbereich aus einem Repository zu öffnen, nimm Clone a repository auf der Git-Seite (siehe Ein Repository klonen).

Lokalen Arbeitsbereich veröffentlichen

Ein lokaler Arbeitsbereich bleibt auf diesem Gerät, bis du ihn veröffentlichst:

  1. Melde dich an.
  2. Öffne in der Arbeitsbereichsauswahl … beim lokalen Arbeitsbereich und wähl Publish to cloud.
  3. Bestätige mit Publish to cloud.

Seine Collections, Requests, Variablen und Umgebungen werden als privater Arbeitsbereich in dein Konto hochgeladen.

Arbeitsbereich forken

Ein Fork ist eine unabhängige Kopie. Öffne … bei einem Arbeitsbereich, wähl Fork workspace und dann ein Ziel:

ZielErgebnis
Persönlich (Cloud)Eine Kopie in deinem Konto.
Lokal (dieses Gerät)Ein Snapshot auf diesem Gerät, der offline funktioniert. Wähl Neuen lokalen Arbeitsbereich erstellen oder Zu bestehendem lokalen Arbeitsbereich hinzufügen.

Setz den Haken bei Variablen und Umgebungen kopieren, um sie mitzunehmen, und klick auf Forken.

Anmelden

  1. Klick rechts in der Titelleiste auf Anmelden.
  2. Klick auf Continue in browser. Dein Browser öffnet Apiboos Anmeldeseite.
  3. Melde dich dort an oder leg ein Konto an: mit E-Mail und Passwort, einem Passkey oder GitHub, dazu mit Zwei-Faktor, falls du ihn eingerichtet hast.
  4. Wechsel zurück zu Apiboo. Das Fenster aktualisiert sich von selbst, sobald du angemeldet bist.

Der Konto-Button zeigt dann deinen Avatar, deinen Vornamen und deinen Plan. Sein Menü enthält Profil, Einstellungen, Plan & billing, Konto wechseln und Abmelden. Name, Bild, Passwort, Passkeys und Zwei-Faktor verwaltest du auf deiner Apiboo-Kontoseite, auf die Einstellungen → Konto verlinkt.

Zwischen Geräten synchronisieren

Sobald du angemeldet bist, synchronisiert Apiboo im Hintergrund. Änderungen gehen etwa eine Sekunde nach dem Bearbeiten raus, und alle 30 Sekunden schaut Apiboo nach Änderungen von deinen anderen Geräten. Offline warten deine Änderungen auf diesem Gerät und gehen raus, sobald die Verbindung wieder da ist; nichts geht verloren. Solange Apiboo seine Server nicht erreicht, zeigt die Titelleiste Offline — reconnecting….

Boards und Dokumente: Cloud oder dieses Gerät

Jedes Board und jedes Dokument liegt entweder in der Cloud (auf deinen anderen Geräten und in der Web-App) oder nur auf diesem Gerät.

  • Neue Boards und Dokumente landen in der Cloud, solange dein Plan dort Platz hat. Ist er voll, bleiben neue auf diesem Gerät. Abgelehnt wird nichts.
  • Eine Unterseite bleibt immer bei ihrer übergeordneten Seite.
  • Verschieb ein Element in beide Richtungen über sein eigenes Menü: In die Cloud verschieben oder Auf dieses Gerät verschieben. Bei Dokumenten ist das das Kontextmenü eines persönlichen Dokuments der obersten Ebene in der Documents-Seitenleiste; Board-Kacheln zeigen ein Cloud- oder Laptop-Badge und einen Button zum Verschieben.
  • In einem Free-Konto erscheinen Dokumente, die nur auf diesem Computer liegen, in der Documents-Seitenleiste unter Auf diesem Gerät.

Bezahlte Pläne halten alles ohne Grenzen in der Cloud. Deine aktuelle Nutzung steht unter Einstellungen → Abrechnung (siehe Plan und Nutzung ansehen).

Sync-Status

Ein Cloud-Symbol erscheint in der Titelleiste, wenn die Synchronisierung deine Aufmerksamkeit braucht: wenn eine Plangrenze nah oder erreicht ist oder etwas nicht synchronisiert werden konnte. Klick darauf, um zu sehen, was betroffen ist und was zu tun ist. Siehe Synchronisierung.

Abmelden und Konto wechseln

Mit Konto wechseln im Kontomenü meldest du dich als jemand anderes an. Das Konto, das du verlässt, behält alles auf diesem Gerät.

Abmelden ist etwas anderes: Es entfernt die Daten dieses Kontos von diesem Computer, mit Ausnahme des Vaults. Deine Cloud-Elemente kommen bei der nächsten Anmeldung zurück, lokale Arbeitsbereiche bleiben erhalten.

Hat dieses Konto Daten, die es nur auf diesem Computer gibt — Boards und Dokumente auf diesem Gerät, noch nicht synchronisierte Änderungen oder Arbeitsbereich-Verläufe, die nur hier verfolgt werden (siehe Auf diesem Gerät verfolgen) —, fragt Abmelden vorher: Auf diesem Gerät behalten und abmelden lässt sie im eigenen Ordner dieses Kontos für die nächste Anmeldung; Entfernen und abmelden löscht sie. Dein Vault bleibt in beiden Fällen.

Teams

Teams teilen Arbeitsbereiche, Boards, Dokumente und Chat-Kanäle. Öffne Teams über das Personen-Symbol in der Titelleiste (nur angemeldet).

Die Teams-Seite mit dem geöffneten Team Bookshop: die Mitglieder Maya und Leo Marchetti mit ihren Rollen und die Arbeitsbereiche des Teams
  • Create team fragt nach einem Teamname, einer optionalen Beschreibung und ob du das Team öffentlich machen (jeder kann es finden und beitreten) willst.
  • Join with code tritt einem Team mit dem Einladungscode bei, den du bekommen hast.
  • Filter deine Teams mit Owned by me, Admin und Member.

Leute einladen

Öffne ein Team und klick auf Einladen. Lade per Shareable link, Email invite oder Code ein und wähl die Rolle, die neue Mitglieder bekommen: viewer, editor oder admin. Ein Link kann nach 7, 30 oder 90 Tagen oder nie ablaufen und mit Require approval eine Freigabe verlangen, bevor jemand hineinkommt.

In der Liste Mitglieder eines Teams klickst du auf die Rolle eines Mitglieds, um sie zu ändern (sofern du darfst). Über das …-Menü der Zeile erreichst du Remove from team.

Arbeitsbereich mit einem Team teilen

  1. Öffne … bei einem persönlichen Cloud-Arbeitsbereich und wähl Share workspace.
  2. Wähl das Team. Du brauchst dort die Rolle Editor, Administrator oder Eigentümer.
  3. Leg bei Bedarf einen Name in der Team-Bibliothek fest.
  4. Setz den Haken bei Variablen und Umgebungen beim Teilen kopieren, um sie mitzunehmen.
  5. Klick auf Mit dem Team teilen.

Der Arbeitsbereich erscheint dann bei allen im Team unter Team-Arbeitsbereiche in ihrer Arbeitsbereichsauswahl.

Organisationen

Eine Organisation steht über deinen Teams: ein Ort, um sie zu verwalten, mit Mitgliedern, verifizierten E-Mail-Domains und einer einzigen Rechnung. Der Umschalter Teams | Organizations auf der Teams-Seite erscheint im Enterprise-Plan oder sobald dich jemand zu einer Organisation hinzugefügt hat.