AgilityManagement

AgilityManagement

Agility Management API JS SDK for retrieving content from the Agility CMS

Source:

Namespaces

Client
Types

Methods

(static) getApi(config) → {AgilityManagement.Client}

How to create an instance of an an API client for the Agility Content Management REST API.

Source:
Parameters:
Name Type Description
config Object

API intialization params.

Name Type Attributes Description
location string

The geo-location of the API you wish to connect to (*USA/Canada).
websiteName string

The Website Name that identifies your Agility Instance [Settings | Global Security].
securityKey string

The Security Key used to authenticate your API requests [Settings | Global Security].
guid string

[not yet in use] The guid that represents your instance.
apiKey string

[not yet in use] The secret token that represents your application.
baseURL string <optional>

Optionally override the default Management API Base Url.
debug boolean <optional>

Optionally turn on debug mode
Returns:
Type:
AgilityManagement.Client
Example
import agilityMgmt from '@agility/content-management'

const mgmtApi = agilityMgmt.getApi({
  location: 'USA',
  websiteName: 'MyWebsiteName',
  securityKey: 'xyz123'
});