> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/api/api-de/api-schnellstart.md).

# API-Schnellstart

## ![](https://984431110-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fdz9Cihd3zGR3GRMtHbln%2Fuploads%2FzF6cQYa8rI5A4rXQeQC1%2FSummary2-Small-Icon.svg?alt=media\&token=b76f02b3-0c59-41c6-8cb7-9c9a6936e554) Ü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:

<table><thead><tr><th width="160">API</th><th>Beschreibung</th></tr></thead><tbody><tr><td><a href="/api/api-de/devops-api/commits.md">DevOps</a></td><td>Erstellen, committen, mergen und deployen Sie Ihre Branches über DevOps.</td></tr><tr><td><a href="/api/api-de/backup-and-archiv-api/backups-and-archives.md">Backup &#x26; Archiv</a></td><td>Erstellen, planen, ausführen und verwalten Sie Ihre Backups und Archive.</td></tr><tr><td><a href="/api/api-de/api-fur-globale-einstellungen/oauth.md">Globale Einstellungen</a></td><td>Authentifizieren Sie die Verbindung zu Ihrem Flosum Cloud Apps-Mandanten.</td></tr></tbody></table>

#### 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.

<table><thead><tr><th width="160.3333740234375">API</th><th>Vereinigte Staaten</th><th>Deutschland</th><th>Japan</th><th>Australien</th></tr></thead><tbody><tr><td>DevOps</td><td>devops-us.flosum.app</td><td>devops-de.flosum.app</td><td>devops-jp.flosum.app</td><td>devops-au.flosum.app</td></tr><tr><td>Backup &#x26; Archiv</td><td>backup-us.flosum.app</td><td>backup-de.flosum.app</td><td>backup-jp.flosum.app</td><td>backup-au.flosum.app</td></tr><tr><td>Globale Einstellungen</td><td>global-us.flosum.app</td><td>global-de.flosum.app</td><td>global-jp.flosum.app</td><td>global-au.flosum.app</td></tr></tbody></table>

{% hint style="warning" %}

### 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.
{% endhint %}

## 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.

{% stepper %}
{% step %}

### 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](/global-settings/global-settings-docs-de/sicherheit/verknupfte-apps/eine-verknupfte-app-fur-den-api-zugriff-erstellen.md)
  {% endstep %}

{% step %}

### Autorisierungscode abrufen

**Endpunkt**: [Broken mention](broken://pages/554b425350f86cb6b6bb5ab0a6721feb75d6231a#get-api-v1-oauth-authorize)

Ö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.
{% endstep %}

{% step %}

### Den Code gegen ein Token austauschen

**Endpunkt**: [Broken mention](broken://pages/554b425350f86cb6b6bb5ab0a6721feb75d6231a#post-api-v1-oauth-token)

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

<table><thead><tr><th width="199.6666259765625">Schlüssel</th><th>Wert</th></tr></thead><tbody><tr><td><code>grant_type</code></td><td><code>authorization_code</code></td></tr><tr><td><code>Code</code></td><td>Der <strong>Autorisierungscode</strong> aus dem vorherigen Schritt.</td></tr><tr><td><code>redirect_uri</code></td><td>Dieselbe Redirect-URI, die im vorherigen Schritt verwendet wurde.</td></tr><tr><td><code>client_id</code></td><td>Ihr <code>Client-ID</code></td></tr><tr><td><code>client_secret</code></td><td>Ihr <code>Client Secret</code></td></tr></tbody></table>

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.
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/api/api-de/api-schnellstart.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.