API-Schnellstart

Überblick

Diese Schnellstartanleitung enthält die wesentlichen Informationen, die Sie benötigen, um mit der Flosum Cloud Apps API zu arbeiten. Sie soll Ihnen helfen, sich schnell zurechtzufinden, damit Sie Anfragen mit Zuversicht stellen können.

Verfügbare APIs

Derzeit verfügbare öffentliche Flosum Cloud Apps-APIs:

API	Beschreibung
DevOps	Erstellen, committen, mergen und deployen Sie Ihre Branches über DevOps.
Backup & Archiv	Erstellen, planen, ausführen und verwalten Sie Ihre Backups und Archive.
Globale Einstellungen	Authentifizieren Sie die Verbindung zu Ihrem Flosum Cloud Apps-Mandanten.

Basis-URL

Die folgende Tabelle enthält die Basis-URL für jede API. Da Flosum-Mandanten regional gehostet werden, verwenden Sie die Basis-URL für die Region, in der Ihr Mandant gehostet wird.

API	Vereinigte Staaten	Deutschland	Japan	Australien
DevOps	devops-us.flosum.app	devops-de.flosum.app	devops-jp.flosum.app	devops-au.flosum.app
Backup & Archiv	backup-us.flosum.app	backup-de.flosum.app	backup-jp.flosum.app	backup-au.flosum.app
Globale Einstellungen	global-us.flosum.app	global-de.flosum.app	global-jp.flosum.app	global-au.flosum.app

Verbindungen vs. Organisationen

In der Flosum Cloud Apps API werden die mit Ihrem Mandanten verbundenen Salesforce-Organisationen genannt Verbindungen, während die Flosum Cloud Apps-Benutzeroberfläche sie als Organisationen. Beide Begriffe beschreiben dieselbe Ressource, daher entspricht eine in der Benutzeroberfläche angezeigte Organisation direkt einer von der API zurückgegebenen Verbindung. Behalten Sie diese Zuordnung im Hinterkopf, wenn Sie UI-Aktionen mit API-Anfragen oder -Antworten abgleichen.

Authentifizierung

Die Flosum Cloud Apps-APIs unterstützen die OAuth-2.0-Authentifizierung über die Global Settings API. Nachfolgend finden Sie die grundlegenden Schritte, die zum Authentifizieren der Verbindung erforderlich sind. Dieser Prozess setzt voraus, dass Sie bereits mit der OAuth-2.0-Authentifizierung mithilfe des authorization_code Ablaufs vertraut sind.

1

Connected App erstellen

Um sich bei Ihrem Flosum Cloud Apps-Mandanten zu authentifizieren, müssen Sie in den Globalen Einstellungen eine Connected App haben. Diese Connected App stellt die für die Authentifizierung verwendeten Werte für Client ID und Client Secret bereit. Informationen zum Erstellen einer Connected App zum Verbinden einer API finden Sie im folgenden Artikel.

• Eine verknüpfte App für den API-Zugriff erstellen

2

Autorisierungscode abrufen

Endpunkt:

Öffnen Sie die Autorisierungs-URL in einem Browser, melden Sie sich bei Global Settings an und genehmigen Sie die verbundene App. Nachdem der Browser zu Ihrer Callback-URL weitergeleitet wurde, kopieren Sie den Code Abfrageparameter aus dieser URL.

3

Den Code gegen ein Token austauschen

Endpunkt:

Senden Sie die Anfrage mit den unten stehenden Body-Schlüsseln.

Schlüssel	Wert
grant_type	authorization_code
Code	Der Autorisierungscode aus dem vorherigen Schritt.
redirect_uri	Dieselbe Redirect-URI, die im vorherigen Schritt verwendet wurde.
client_id	Ihr Client-ID
client_secret	Ihr Client Secret

Eine erfolgreiche 200 Antwort liefert ein access_token und ein refresh_token. Übergeben Sie das access_token im Authorization: Bearer -Header bei nachfolgenden API-Aufrufen, und speichern Sie das refresh_token , damit Sie ein neues Zugriffstoken erhalten können, wenn das aktuelle abläuft.