Quick Start

Get up and running in minutes with Intelligent Risk Platform™

Overview

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

RMS APIs enable authenticated clients to securely connect to Intelligent Risk Platform and perform risk modeling tasks. 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 user account. The client must pass a valid API key to Intelligent Risk Platform whenever it makes a request. The API key enables the RMS Authentication service to authenticate the client and determine that user’s access rights.

Step 1: Obtain tenant name and API key

Access to Intelligent Risk Platform is tenant-based and controlled by means of API keys. 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 RMS API operation

An operation consists of an HTTP method (e.g. GET, POST, DELETE) and a URL.

800800

Data Bridge API operation

An operation consists of a method, scheme, host, and path. The path (endpoint) consists of three parts: app path, base path, and service path.

  • 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 app path identifies the RMS application. For example, /riskmodeler or /databridge.
  • The base path identifies the version number of the service. Risk Modeler APIs are periodically upgraded and versioned. To learn more about our versioning policy, see Policies.
  • The service path defines a path to a resource. The service 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 Risk Modeler query parameters, see Query Exposure Data.

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 service enables you to request information about one or more EDM data sources.

curl --request GET \
    --url https://{host}/riskmodeler/v1/datasources \
    --header 'Accept: application/json' \
    --header 'Authorization: XXXXXXXXXX'

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.

{ 
  "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 services require that you specify the name of an EDM (the dataSourceName) as a query parameter that is appended to the service endpoint.


Did this page help you?