Overview

Intelligent Risk Platform is a cloud-based platform for advanced modeling and risk analysis tasks. Licensed Data Bridge tenants may access and use RMS APIs.

Moody's RMS APIs enable authenticated clients to securely connect to Intelligent Risk Platform and perform risk modeling and data management tasks.

Step 1: Obtain host name and API key

Intelligent Risk Platform manages the authentication and authorization of clients by means of API keys. An API key is a token that uniquely identifies a client application. The client must pass a valid API key to the Intelligent Risk Platform whenever it makes a request. To learn more, see Authentication and Authorization.

In Data Bridge, this API key specifies the access rights and permissions granted to the client. To learn more, see Access Controls.

During onboarding, your tenant administrator will provide you with a host name and an API key:

• The host name identifies the data center hosting your company's Intelligent Risk Platform application instance (e.g. a Risk Modeler instance). One of api-euw1.rms.com or api-use1.rms.com.
• The API key is a token that enables Intelligent Risk Platform to authenticate requests. Every API key is tied to a specific tenant and assigned to one or more groups.

If you do not know have an API key or do not know the name of your host environment, contact your tenant administrator.

Step 2: Understand RMS API operation endpoints

An operation a callable unit of a RESTful API that consists of an HTTP method (e.g. GET, POST, DELETE) and a URL that consists of a scheme, host, and a path that identifies the resource.

The host identifies the data center that hosts your company's tenant instance: api-euw1.rms.com or api-use1.rms.com. The host is sometimes referred to as the {host} variable in Postman collections and some code samples. Whenever you see the {host} variable in an example, you must substitute the correct host name.

In Data Bridge, the path consists of an app path, base path, and operation path.

• The app path identifies the RMS application. For example, /riskmodeler or /databridge.
• The base path identifies the version number of the service. Data Bridge APIs are periodically upgraded and versioned. To learn more about Intelligent Risk Platform versioning policies, see Policies.
• The operation path defines a path to a resource. The operation path may include path parameters and query parameters. Our API Reference documentation provides detailed information about the parameters that may be defined in the path of each service.

Step 3: Make a test API request

You can now confirm that the API key is working by making a request to Intelligent Risk Platform.

The Get Client IP Address service enables you to request information about the client making a request. This resoruce is perfect for confirming that we are authenticated and authorized to use the Data Bridge API.

curl --request GET \
     --url https://{host}/databridge/v1/MyIp \
     --header 'Authorization: XXXXXXXXXX' \
     --header 'accept: application/json'

A successful request returns information about the specified EDM including the datasourceId, datasourceName, ownerId, and metrics attributes.

  "clientIP": "165.225.242.XXX",
  "isAllowed": true
}