> 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-pt-br/guia-rapido-da-api.md).

# Guia rápido da API

## ![](https://4059597209-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) Visão geral

Este guia de início rápido fornece as informações essenciais de que você precisa para começar a trabalhar com a API Flosum Cloud Apps. Ele foi desenvolvido para ajudar você a se orientar rapidamente para que possa começar a fazer solicitações com confiança.

### APIs disponíveis

APIs públicas do Flosum Cloud Apps disponíveis no momento:

<table><thead><tr><th width="160">API</th><th>Descrição</th></tr></thead><tbody><tr><td><a href="/api/api-pt-br/api-de-devops/commits.md">DevOps</a></td><td>Crie, faça commit, faça merge e implante seus branches por meio do DevOps.</td></tr><tr><td><a href="/api/api-pt-br/api-de-backup-e-arquivo/backups-and-archives.md">Backup e Arquivamento</a></td><td>Crie, agende, execute e gerencie seus backups e arquivos.</td></tr><tr><td><a href="/api/api-pt-br/api-de-configuracoes-globais/oauth.md">Configurações globais</a></td><td>Autentique a conexão com seu tenant do Flosum Cloud Apps.</td></tr></tbody></table>

#### URL base

A tabela abaixo lista a URL base de cada API. Como os tenants da Flosum são hospedados regionalmente, use a URL base da região em que seu tenant está hospedado.

<table><thead><tr><th width="160.3333740234375">API</th><th>Estados Unidos</th><th>Alemanha</th><th>Japão</th><th>Austrália</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 e Arquivamento</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>Configurações globais</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" %}

### Conexões vs. Organizações

Na API do Flosum Cloud Apps, as organizações do Salesforce conectadas ao seu tenant são chamadas de **Conexões**, enquanto a interface do Flosum Cloud Apps se refere a elas como **Organizações**. Ambos os termos descrevem o mesmo recurso, então uma Organização exibida na interface corresponde diretamente a uma Conexão retornada pela API. Tenha esse mapeamento em mente ao cruzar ações da interface com solicitações ou respostas da API.
{% endhint %}

## Autenticação

As APIs do Flosum Cloud Apps oferecem suporte à autenticação OAuth 2.0 por meio da API de Configurações globais. Abaixo estão as etapas básicas necessárias para autenticar a conexão. Este processo pressupõe que você já esteja familiarizado com a autenticação OAuth 2.0 usando o `authorization_code` fluxo.

{% stepper %}
{% step %}

### Criar Aplicativo Conectado

Para autenticar com seu tenant do Flosum Cloud Apps, você deve ter um Aplicativo Conectado em Configurações globais. Esse Aplicativo Conectado fornece os valores de ID do cliente e Segredo do cliente usados na autenticação. Para saber como criar um Aplicativo Conectado para conectar uma API, consulte o artigo a seguir.

* [Criando um aplicativo conectado para acesso à API](/global-settings/global-settings-docs-pt-br/seguranca/aplicativos-conectados/criando-um-aplicativo-conectado-para-acesso-a-api.md)
  {% endstep %}

{% step %}

### Obter código de autorização

**Endpoint**: [Broken mention](broken://pages/4cfe796043027209b96a0a8d27ce0823840a27eb#get-api-v1-oauth-authorize)

Abra a URL de autorização em um navegador, faça login em Configurações globais e aprove o aplicativo conectado. Depois que o navegador redirecionar para sua URL de callback, copie o `code` parâmetro de consulta dessa URL.
{% endstep %}

{% step %}

### Trocar o código por um token

**Endpoint**: [Broken mention](broken://pages/4cfe796043027209b96a0a8d27ce0823840a27eb#post-api-v1-oauth-token)

Envie a solicitação usando as chaves do corpo abaixo.

<table><thead><tr><th width="199.6666259765625">Chave</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>O <strong>código de autorização</strong> da etapa anterior.</td></tr><tr><td><code>redirect_uri</code></td><td>A mesma URI de redirecionamento usada na etapa anterior.</td></tr><tr><td><code>client_id</code></td><td>Seu <code>ID do cliente</code></td></tr><tr><td><code>client_secret</code></td><td>Seu <code>Segredo do cliente</code></td></tr></tbody></table>

Uma `200` resposta bem-sucedida retorna um `access_token` e um `refresh_token`. Passe o `access_token` em `Authorization: Bearer` cabeçalho nas chamadas subsequentes da API e armazene o `refresh_token` para que você possa obter um novo token de acesso quando o atual expirar.
{% 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-pt-br/guia-rapido-da-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.