Overview

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

Intelligent Risk Platform is a cloud-based platform for advanced modeling and risk analysis tasks. Licensed tenants may access and use Platform APIs by means of API keys, which manage authentication and authorization. The client may only perform operations granted to it based on group membership and role-based access rights.

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.

The 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 application 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 Platform resources

A resource a callable unit of a RESTful API that consists of an HTTP request method and an endpoint (URL) that consists of a scheme, host, and path:

The method specifies the HTTP request method (AKA http verb) that specifies the action to be performed on a resource data set. Platform APIs support GET, POST, PUT, and DELETE requests. Depending on the HTTP requet method specified, the resource retrieves, creates, updates, or deletes an instance of the specified resource data set. Some POST and PUT requests and all GET requests are idempotent.

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.

The path consists of an app path, api path, version path, and resource path.

• The app path identifies the Moody's RMS application. For example, platform or databridge.
• The api path identifies the Platform API. Platform APIs include riskdata, admindata, tenantdata, and import. Each API includes resources that enable you to manage a distinct functional area of the Intelligent Risk Platform.
• The version path identifies the version number of the resource. Platform APIs are periodically upgraded and versioned. To learn more about Platform versioning policies, see Versioning Policy.
• The resource path identifies Intelligent Risk Platform resource data set, the data set accessible through the endpoint. The resource 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. To learn more about Platform query parameters, see Response Filtering.

Step 3: Make a test API request

You can now confirm that the API key is working by making a request using a Platform API resource.

The Get EDMs resource enables you to request information about a tenant's Exposure Data Modules (EDMs).

curl --request GET \
     --url 'https://api-euw1.rms.com/platform/riskdata/v1/exposures' \
     --header 'Authorization: XXXXXXXXXXX'

The Exposure Data Module (EDM) is a cloud-based database structure that stores the detailed exposure, hazard, and financial information for use in catastrophe modeling. Exposure data stored in an EDM may be used for risk analysis or for migration to other RMS products. A tenant may own multiple EDMs on multiple servers.

Your ability access and view specific EDMs is determined by the API key that you provide to the service. Every API key is tied to one or more groups and your ability to access specific EDM data sources is determined by the API key specified in the Authorization header.

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

[
  {
    "exposureName": "my_edm",
    "exposureId": 3,
    "uri": "string",
    "status": "string",
    "databaseName": "string",
    "metrics": {
      "additionalProp": {}
    },
    "ownerName": "string",
    "exposureSetId": 45,
    "serverType": "PLATFORM",
    "serverName": "string",
    "serverId": 0
  }
]