# Início rápido da API

## ![](/files/646418937f2417c15fb7c1ba51844592ba5fd702) 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 do Flosum Cloud Apps. Ele foi criado para ajudá-lo a se orientar rapidamente, para que você possa começar a fazer requisições com confiança.

### APIs disponíveis

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

<table><thead><tr><th width="160">API</th><th>Descrição</th></tr></thead><tbody><tr><td><a href="/pages/857345d2b7d628fe3f1cf13f2c5fe3da35017063">Configurações Globais</a></td><td>Autentica a conexão com seu tenant do Flosum Cloud Apps.</td></tr><tr><td><a href="/pages/21d12dced037693432412c411b48fbb1509a49a1">Backup e Arquivamento</a></td><td>Crie, agende, execute e gerencie seus backups e arquivos arquivados.</td></tr></tbody></table>

#### URL base

A tabela abaixo lista a URL base de cada API. Como os tenants do 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>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><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></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, portanto 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 requisiçõ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 fluxo `authorization_code` .

{% 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 Connected App para Acesso à API](/global-settings/global-settings-docs-pt-br/seguranca/connected-apps/criando-um-connected-app-para-acesso-a-api.md)
  {% endstep %}

{% step %}

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

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

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

{% step %}

### Trocar o código por um token

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

Envie a requisição usando as chaves de 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 um `cabeçalho Authorization: Bearer` 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: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.flosum.com/api/api-pt-br/inicio-rapido-da-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.