> 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-es/inicio-rapido-de-la-api.md).

# Inicio rápido de la API

## ![](https://608698572-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) Descripción general

Esta guía de inicio rápido proporciona la información esencial que necesita para comenzar a trabajar con la API de Flosum Cloud Apps. Está diseñada para ayudarle a orientarse rápidamente para que pueda empezar a realizar solicitudes con confianza.

### APIs disponibles

APIs públicas de Flosum Cloud Apps disponibles actualmente:

<table><thead><tr><th width="160">API</th><th>Descripción</th></tr></thead><tbody><tr><td><a href="/api/api-es/api-de-devops/commits.md">DevOps</a></td><td>Cree, confirme, fusione e implemente sus ramas a través de DevOps.</td></tr><tr><td><a href="/api/api-es/api-de-copia-de-seguridad-y-archivo/backups-and-archives.md">Copia de seguridad y archivo</a></td><td>Cree, programe, ejecute y administre sus copias de seguridad y archivos.</td></tr><tr><td><a href="/api/api-es/api-de-configuracion-global/oauth.md">Configuración global</a></td><td>Autentique la conexión con su tenant de Flosum Cloud Apps.</td></tr></tbody></table>

#### URL base

La tabla siguiente enumera la URL base de cada API. Debido a que los tenants de Flosum están alojados por región, utilice la URL base de la región donde esté alojado su tenant.

<table><thead><tr><th width="160.3333740234375">API</th><th>Estados Unidos</th><th>Alemania</th><th>Japón</th><th>Australia</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>Copia de seguridad y archivo</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>Configuración global</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" %}

### Conexiones frente a organizaciones

En la API de Flosum Cloud Apps, las organizaciones de Salesforce conectadas a su tenant se denominan **Conexiones**, mientras que la interfaz de usuario de Flosum Cloud Apps se refiere a ellas como **Organizaciones**. Ambos términos describen el mismo recurso, por lo que una Organización mostrada en la interfaz de usuario corresponde directamente a una Conexión devuelta por la API. Tenga presente esta correspondencia cuando compare acciones de la interfaz de usuario con solicitudes o respuestas de la API.
{% endhint %}

## Autenticación

Las APIs de Flosum Cloud Apps admiten la autenticación OAuth 2.0 a través de la API de Configuración global. A continuación se indican los pasos básicos necesarios para autenticar la conexión. Este proceso asume que ya está familiarizado con la autenticación OAuth 2.0 usando el `authorization_code` flujo.

{% stepper %}
{% step %}

### Crear aplicación conectada

Para autenticarse con su tenant de Flosum Cloud Apps, debe tener una aplicación conectada en Configuración global. Esta aplicación conectada proporciona los valores de ID de cliente y secreto de cliente utilizados en la autenticación. Para aprender cómo crear una aplicación conectada para conectar una API, consulte el siguiente artículo.

* [Crear una aplicación conectada para acceso a la API](/global-settings/global-settings-docs-es/seguridad/aplicaciones-conectadas/crear-una-aplicacion-conectada-para-acceso-a-la-api.md)
  {% endstep %}

{% step %}

### Obtener código de autorización

**Punto de conexión**: [Broken mention](broken://pages/4343967e17f46cb7c4f25e326d0b8070144b7ec8#get-api-v1-oauth-authorize)

Abra la URL de autorización en un navegador, inicie sesión en Configuración global y apruebe la aplicación conectada. Después de que el navegador redirija a su URL de devolución de llamada, copie el `code` parámetro de consulta de esa URL.
{% endstep %}

{% step %}

### Intercambiar el código por un token

**Punto de conexión**: [Broken mention](broken://pages/4343967e17f46cb7c4f25e326d0b8070144b7ec8#post-api-v1-oauth-token)

Envíe la solicitud usando las claves del cuerpo que se indican a continuación.

<table><thead><tr><th width="199.6666259765625">Clave</th><th>Valor</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>El <strong>código de autorización</strong> del paso anterior.</td></tr><tr><td><code>redirect_uri</code></td><td>La misma URI de redirección utilizada en el paso anterior.</td></tr><tr><td><code>client_id</code></td><td>Su <code>ID de cliente</code></td></tr><tr><td><code>client_secret</code></td><td>Su <code>Secreto de cliente</code></td></tr></tbody></table>

Una exitosa `200` respuesta devuelve un `access_token` y un `refresh_token`. Pase el `access_token` en el `Authorization: Bearer` encabezado en las llamadas posteriores a la API, y almacene el `refresh_token` para que pueda obtener un nuevo token de acceso cuando el actual caduque.
{% 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-es/inicio-rapido-de-la-api.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.