Inicio rápido de la API

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:

API	Descripción
DevOps	Cree, confirme, fusione e implemente sus ramas a través de DevOps.
Copia de seguridad y archivo	Cree, programe, ejecute y administre sus copias de seguridad y archivos.
Configuración global	Autentique la conexión con su tenant de Flosum Cloud Apps.

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.

API	Estados Unidos	Alemania	Japón	Australia
DevOps	devops-us.flosum.app	devops-de.flosum.app	devops-jp.flosum.app	devops-au.flosum.app
Copia de seguridad y archivo	backup-us.flosum.app	backup-de.flosum.app	backup-jp.flosum.app	backup-au.flosum.app
Configuración global	global-us.flosum.app	global-de.flosum.app	global-jp.flosum.app	global-au.flosum.app

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.

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.

1

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

2

Obtener código de autorización

Punto de conexión:

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.

3

Intercambiar el código por un token

Punto de conexión:

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

Clave	Valor
grant_type	authorization_code
code	El código de autorización del paso anterior.
redirect_uri	La misma URI de redirección utilizada en el paso anterior.
client_id	Su ID de cliente
client_secret	Su Secreto de cliente

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.