Guia rápido da API

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:

API	Descrição
DevOps	Crie, faça commit, faça merge e implante seus branches por meio do DevOps.
Backup e Arquivamento	Crie, agende, execute e gerencie seus backups e arquivos.
Configurações globais	Autentique a conexão com seu tenant do Flosum Cloud Apps.

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.

API	Estados Unidos	Alemanha	Japão	Austrália
DevOps	devops-us.flosum.app	devops-de.flosum.app	devops-jp.flosum.app	devops-au.flosum.app
Backup e Arquivamento	backup-us.flosum.app	backup-de.flosum.app	backup-jp.flosum.app	backup-au.flosum.app
Configurações globais	global-us.flosum.app	global-de.flosum.app	global-jp.flosum.app	global-au.flosum.app

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.

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.

1

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

2

Obter código de autorização

Endpoint:

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.

3

Trocar o código por um token

Endpoint:

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

Chave	Valor
grant_type	authorization_code
code	O código de autorização da etapa anterior.
redirect_uri	A mesma URI de redirecionamento usada na etapa anterior.
client_id	Seu ID do cliente
client_secret	Seu Segredo do cliente

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.