Overview

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

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 Risk Modeler and Data Bridge, this API key specifies the access rights and permissions granted to the client. To learn more, see Access Rights.

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 Risk Modeler, Data Bridge, or Location Intelligence 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 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 Risk Modeler and 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 resource. Risk Modeler APIs are periodically upgraded and versioned. To learn more about Risk Modeler and Data Bridge 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 resource. To learn more about Risk Modeler query parameters, see Filter Exposure Data.

📷

Resource Groups

Risk Modeler API endpoints that initiate workflow jobs accept an optional custom header X-Rms-Resource-Group-Id that can be used to specify the ID number of a resource group. Intelligent Risk Platform utilizes resource groups to ensure that a tenant's resource quota is correctly allocated within the tenant's organization. To learn more, see Resource Groups.

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 EDMs resource enables you to request information about one or more Exposure Data Modules (EDMs). The EDM is a cloud-based data structure for storing exposure data.

curl --location --request GET 'https://{host}/riskmodeler/v1/datasources' \
--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 resource. 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.

{ 
  "datasourceId": 345, 
  "datasourceName": "my_edm", 
  "dbType": 3, 
  "permissionType": 12, 
  "isDefault": false, 
  "metrics": { 
    "AggPortCount": 0, 
    "LastModified": "2020-02-21 19:40:15.19", 
    "TreatyCount": 0, 
    "Size": "500 MB", 
    "EDMVersion": "18", 
    "PortCount": 0, 
    "LocCount": 2, 
    "AcctCount": 10, 
    "CedantCount": 0 
  }, 
  "ownerId": "XXXXXXXXXX", 
  "owner": "XXXXXXXXXX" 
} 

A tenant may maintain multiple EDMs; consequently, many Risk Modeler operations require that you specify the name of an EDM (the dataSourceName) as a query parameter that is appended to the operation path.