Getting Started Guide

 

Introduction

The Liberty Mutual Developers Portal is an interactive portal that allows you to view API documentation, register your client "Apps", manage your keys, and try the APIs in real-time. The "try it out" feature is not available for all APIs

 

API Product Documentation

The Products menu link will take you to a list of all APIs. Clicking on an API name in the list will take you to a page that lists the resources and methods for that API. You can then click on a resource method, which will take you to an interactive page that will provide a more complete set of documentation, including a Description, Resource URL, Header Parameters, Body Parameters, Response Error Detail, and Resource Summary, etc. There are also a set of tabs that display Request, Response, and cURL output. This page is also where you can interactively send a request using your keys, and see real-time examples of the Request, Response, and cURL command.

Note: While you can always view API documentation, you won't be able to use or try APIs without logging in with a registered developer account.

 

Login

In order to use the APIs, you will first need to login to the portal and access the Keys page, which is where you will register your "Apps" and get the keys needed to access the APIs.

 

Keys

In order to call APIs you will need to get keys that are associated to your "Apps". The Keys page will allow you to register your "Apps", subscribe to API products, and retrieve your keys (Consumer Key and Consumer Secret). Each "App" can include one or more API products. Once an "App" is created you can access all the necessary information needed by clicking on the "App" name.

This section also provides additional information and includes the following tabs:

  • Details
  • Products
  • Keys
  • Analytics
  • Edit App
  • Delete App

 

Keys

Keys are necessary to call APIs and are generated when creating an app and selecting API products. Once generated, these keys will be used to access the APIs. These keys are associated with your app and are used for access and to identify your app as the user of the API. Once created, it's very important that you secure these keys and manage them appropriately. The keys can be regenerated, revoked, or deleted if necessary. In some cases, APIs will simply require an API key (Consumer Key), but in other cases such as OAuth, you will be required to use the full key combination (Consumer Key and Consumer Secret). These keys are also used to collect app-level analytics for the APIs you're registered to use.

 

Products

A product is a collection of APIs and their resources. An API product bundles API resources and provides a specific level of access and functionality for app developers. An API product typically specifies a list of API resources along with access limits, rate plans, key approval method, and other product specific information.

 

Analytics

Analytics Services collects and analyzes a broad spectrum of data that flows across APIs. For example, while the API is deployed the analytics system is constantly counting and analyzing metrics like the number of messages received, number of developers, response times, errors, number of apps in use, request size, and many others.

To see the analytics specific to your key, access your key on the Keys page and select the Analytics tab:

  • Throughput
  • Max Response Time
  • Min Response Time
  • Endpoint Response Time
  • Message Count
  • Error Count
  • User Count