API Quickstart

Overview

This quickstart provides the essential information you need to start working with the Flosum Cloud Apps API. It is designed to help you get oriented quickly so you can begin issuing requests with confidence.

Available APIs

Currently available Flosum Cloud Apps public APIs:

API	Description
DevOps	Create, commit, merge, and deploy your branches through DevOps.
Backup & Archive	Create, schedule, run, and manage your backups and archives.
Global Settings	Authenticate the connection to your Flosum Cloud Apps tenant.

Base URL

The table below lists the base URL for each API. Because Flosum tenants are regionally hosted, use the base URL for the region where your tenant is hosted.

API	United States	Germany	Japan	Australia
DevOps	devops-us.flosum.app	devops-de.flosum.app	devops-jp.flosum.app	devops-au.flosum.app
Backup & Archive	backup-us.flosum.app	backup-de.flosum.app	backup-jp.flosum.app	backup-au.flosum.app
Global Settings	global-us.flosum.app	global-de.flosum.app	global-jp.flosum.app	global-au.flosum.app

Connections vs Organizations

In the Flosum Cloud Apps API, the Salesforce orgs connected to your tenant are called Connections, whereas the Flosum Cloud Apps UI refers to them as Organizations. Both terms describe the same resource, so an Organization shown in the UI corresponds directly to a Connection returned by the API. Keep this mapping in mind when cross-referencing UI actions with API requests or responses.

Authentication

The Flosum Cloud Apps APIs support OAuth 2.0 authentication through the Global Settings API. Below are the basic steps required to authenticate the connection. This process assumes you are already familiar with OAuth 2.0 authentication using the authorization_code flow.

1

Create Connected App

To authenticate with your Flosum Cloud Apps tenant, you must have a Connected App in Global Settings. This Connected App provides the Client ID and Client Secret values used in authentication. To learn how to create a Connected App to connect an API, see the following article.

• Creating a Connected App for API Access

2

Get Authorization Code

Endpoint: GET /api/v1/oauth/authorize

Open the authorization URL in a browser, sign in to Global Settings, and approve the connected app. After the browser redirects to your callback URL, copy the code query parameter from that URL.

3

Exchange the Code for a Token

Endpoint: POST /api/v1/oauth/token

Send the request using the body keys below.

Key	Value
grant_type	authorization_code
code	The Authorization Code from the previous step.
redirect_uri	The same redirect URI used in the previous step.
client_id	Your Client Id
client_secret	Your Client Secret

A successful 200 response returns an access_token and a refresh_token. Pass the access_token in the Authorization: Bearer header on subsequent API calls, and store the refresh_token so you can obtain a new access token when the current one expires.