RMS Developer Blog

Read the latest announcements, product news, and insights into Intelligent Risk development from RMS Developer Resources.

Introducing RMS Developer Portal

June 14, 2022

RMS proudly announces the official launch of RMS Developer Portal, a central hub for development tools and resources for creating risk management solutions that leverage the RMS Intelligent Risk Platform™ . RMS Developer Portal replaces the older developer portal on Information Central and represents a renewed commitment to delivering tools and resources that can drive the success of our customers.

The new developer portal is designed to meet the needs of new and experienced developers. RMS Developer Portal provides quick start guides, conceptual overviews, and recipes for workflows that enable developers unfamiliar with RMS APIs to get up and running quickly. Experienced developers will find complete and accurate documentation of API services and endpoints enabling them to develop more powerful applications. RMS Developer Portal makes all of this information more accessible and understandable by providing powerful search engine, conceptual overviews, and inline glossary definitions.

RMS Developer Portal is divided into three primary sections: Developer Guides, API Reference, and the Changelog. Each section is accessible through the global menu.

Developer guides

RMS Developer guides provide a broad, conceptual overview of the Intelligent Risk Platform and the Risk Modeler, Location Intelligence, and Data Bridge APIs.

RMS Intelligent Risk Platform is a cloud-based platform for advanced modeling and risk analytics that enables enables developers to build custom applications that deliver competitive advantages to insurers and reinsurers.

The Risk Modeler, Location Intelligence, and Data Bridge developer guides facilitate the onboarding of new developers through conceptual overviews and step-by-step tutorials. Each developer guide provides a framework for understanding the potential benefits of that API and a roadmap for building custom applications that leverage API services to automate and streamline risk management processes

11001100

RMS Developers guide documentation

Each developer guide documents standard workflows that define recipes for custom applications that will give your business competitive advantages. A workflow is a recipe that defines a standard catastrophe modeling or data management process, e.g. Analyzing portfolio exposures or Migrating location exposures to the Intelligent Risk Platform. A workflow is generally composed of multiple requests that utilized several different API services.

  • The Get Started Developer Guide provides general information about Intelligent Risk Platform and RMS APIs, documents security, versioning, and deprecation policies, and describes how the platform manages authentication and authorization. The Quick Start provides step-by-step instructions for getting up and running in minutes with the Intelligent Risk Platform.
  • The Risk Modeler Developer Guide provides a broad overview of the Risk Modeler API and explains how Risk Modeler services may be leveraged to build catastrophe modeling and data management applications. The developer guide pays particular attention to the various methods available for uploading and importing exposure data onto the platform for analysis and exporting and downloading of analysis results.
  • The Location Intelligence Developer Guide describes how developers may build applications that leverage RMS data products to deliver accurate risk assessment with minimal overhead or latency. Location Intelligence APIs integrate seamlessly into existing workflows enabling you to enhance existing policy admin systems, underwriting applications, agency portals, and spreadsheet-based workflows.
  • The Data Bridge Developer Guide describes workflows that enable customers to share data between cloud-based and on-premise systems.

Developer guides include tutorials that describe step-by-step instructions for defining standard catastrophe modeling and data management workflows and downloadable developer resources (e.g. OpenAPI specifications, Postman collections, Juptyer Notebooks).

API reference

RMS API Reference documentation offers complete reference documentation of the Risk Modeler, Location Intelligence, and Data Bridge APIs. Whereas the developer guides provide a conceptual overview of the APIs and describe how API services fit together to define workflows of risk assessment processes, reference documentation provide detailed information about the nuts and bolts of each API service.

Reference documentation includes all information needed to build RESTful applications using services. API Reference documentation groups services by API (e.g. Risk Modeler, Location Intelligence, and Data Bridge) and collection-- a group of services that operate on the same resource.

11001100

RMS Developers API Reference documentation

Throughout RMS Developers, we use the term service to refer to the combination of an endpoint and a method. Some services share a common endpoint, but different employ distinct methods to operate on a resource made available through that endpoint. For example, the Update account service and Delete account services share the same endpoint (https://{host}/riskmodeler/v2/accounts), but employ different methods (POST and DELETE respectively).

For each service, RMS Developers documents its canonical name, the role of the service or resource, the service method and endpoint, required and optional parameters, and responses.

  • The service summary defines a canonical name for a specific service. This canonical name uniquely identifies the service throughout RMS Developers: in API Reference navigation structures, workflows, changelogs, and search results.
  • The service description provides a detailed explanation for using a specific service to accomplish tasks as part of standard workflows. A service generally enables the caller to perform an operation on an API resource, the target of of an HTTP request. In general, an RMS API resource corresponds to a schema that defines the structure of data. RMS API services enable clients to manage objects that conform to a resource schema, e.g. creating, updating, and deleting individual accounts.
  • The method specifies the HTTP request method that identifies the operation performed on the service resource. One of GET, POST, PUT, or DELETE.
  • The endpoint identifies the unique URL for accessing the service resource. A service endpoint is defined by two elements: a host, and a path. Depending on the method specified, an endpoint may support distinct operations (e.g. creating or deleting an instance of a resource).
  • A service parameter defines the scope of a service request. A service may support three types of parameters: path parameters, query parameters, and body parameters. A path parameter identifies the specific object (e.g. portfolio, location, analysis result) for a request usually by specifying that object's unique ID in the endpoint path. A query parameter enables the client to filter the data returned by the request in a query string that is appended to the service endpoint. For detailed information on how query parameters are employed in Risk Modeler API services, see Query Parameters. A body parameter specifies the value of an object attribute in the body (application/json) of a request to create or update a resource. that resource, so it has to be present in the request body, else the request body would be able to represent the whole resource information.
  • A response generally consists of the HTTP response status code and data that is returned in the response body or Location header. In general, successful GET requests return a 200 HTTP status code and data in a request body. Successful POST or PUT service requests frequently return a 201 or 202 HTTP status code and information about the request in the Location header.

RMS Developers provides examples the body parameters for requests in the service descriptions of select services. Alternatively, the Query Builder provides a GUI for building requests by specifying path, query, and body parameters. As you add new parameters they are added to the endpoint in the sample request.

You can view sample request packages by selecting the Request Examples option in the Examples dropdown list.

11001100

Request example in the Query Builder

Developer resources

RMS Developers offers several development resources in addition to the Developer Guides and API Reference documentation: Postman Collection, OpenAPI specifications in JSON and YAML, and Jupyter Notebooks.

Changelog

The Changelog represents a log of all changes to RMS APIs on a monthly basis.

11001100

RMS Developers Changelog

Updates to RMS APIs are generally introduced independently of new versions of our APIs. The Risk Modeler 2.0 API is available in two versions (v1 and v2) and non-breaking changes to both versions of the API are made frequently.

The Location Intelligence API defines services that enable you to validate and enrich the quality of location exposure data using RMS data product. Updates to the Location Intelligence API generally follow the introduction of new data products.

RMS Technical Blogs

RMS Technical blogs share product release updates, including new APIs to integrate with RMS applications and automate your workflows. They also include detailed technical information about new features and capabilities and new administrative tools to help manage your tenant.

Upcoming

The updated RMS Developers represents a major improvement to the RMS developer experience that represents our commitment to ensuring the success of RMS developers.

In the coming months, we plan to expand our roster of public APIs and provide RMS customers with more options and greater flexibility to leverage the Intelligent Risk Platform in risk management processes.

RMS will continue to improve the quality and versatility of our existing staple of public APIs. In the coming months, you will see updates to Risk Modeler 2.0, Data Bridge, and Location Intelligent. Of course, all of these changes will be catalogued in the Changelog.

RMS Developers will document new services, provide updated information on all changes, and greater detail throughout the rollout of these APIs.