Managed APIs Page

Managed APIs provide access to any web-connectable data. They contain details and credentials to be used when consuming data from a web resource. The primary use case for Managed APIs is using them in scripts.

Managed APIs page

The Managed APIs page displays Managed APIs view. On this page you can:

• Create a new Managed API by clicking the plus button on the top right corner of the view
• Edit a Managed API by clicking on it in the view

Managed API Editor

The editor lets you create a new or edit an existing Managed API. A Managed API has following fields:

• Programmatic Name: a language-independent (programmatic) name to be used within scripts
• Display name: a human language name for display purposes
• Description: an optional description
• Image: an image for display purposes
• Base URL: the root URL of the API. Scripts call the API with paths relative to this URL via ManagedAPIService.fetch
• Authentication: how the Mobile SDK authenticates requests to this API, see Authentication
• Key Value Pairs: a list of arbitrary key - value mappings

Managed API Editor

Key Value Pairs

The key value mapping is intended to store anything that is required to consume the Managed API within native code or scripts. Anything that the code may need should be stored here, for example default query parameters, resource identifiers or feature flags. Credentials and the base URL have dedicated fields and do not belong here.

Secure Storage

The Mobile SDK stores Managed API key-value pairs securely on iOS KeyChain and Android KeyStore.

Authentication

The authentication type tells the Mobile SDK how to authenticate every request made through ManagedAPIService.fetch. Scripts never handle credentials or tokens themselves.

Type	Settings	Behaviour on the device
None	–	Requests are sent as-is.
Basic	Username, Password	Authorization: Basic header.
Bearer Token	Token	Authorization: Bearer header.
API Key	Key Name, Key Value, Location (Header, Query Param, Cookie)	The key is added at the chosen location.
OAuth 2.0	Grant Type (Authorization Code, Client Credentials, Password), Client ID, Client Secret, Add Credentials To, Token URL, Scope, additional parameters. Authorization Code also takes Authorization URL, Redirect URI, State and Use PKCE; Password also takes Username and Password	The SDK runs the grant (opening the consent screen for Authorization Code), stores the token securely, refreshes it when it expires and re-authorizes when needed. Additional parameters are appended to the authorization URL.

Secure Storage

Authentication settings and OAuth tokens are stored on iOS KeyChain and Android KeyStore, separately from the key-value pairs. They are not exposed to scripts.