Accessing SAFE APIs

1. Introduction

SAFE offers a series of REST APIs that allow customers and partners to extend and leverage existing investments in other software and systems by synchronizing and sharing data between the systems.

The SAFE REST API allows third-party software and systems to extract information from the SAFE platform. Integration can be accomplished using a series of different technologies depending on your needs and existing infrastructure. SAFE REST API that extracts data from SAFE can add additional context to other Security tools.

2. Access SAFE APIs

To access the SAFE REST APIs:

1. Login to SAFE.
2. Click the User Profile availabe in the top-right of the screen.
3. Click the Help option and then click the SAFE API option. You will be redirected to the SAFE API portal.

3. SAFE REST API documentation portal

SAFE API documentation is available on Swagger. Swagger is an Interface Description Language for describing RESTful APIs expressed using JSON. Once you go to the SAFE REST APIs portal, you need to authenticate yourself to use the APIs.

4. Generate API Credentials

To generate the SAFE API credentials:

1. Login to SAFE.
2. Navigate to Administration > User Management.
3. Search for the user for whom you want to create the API credentials.
4. Click the Edit icon available for the user. The system redirects you to the Edit User page.
   
5. On the Edit User page, click the Generate API Credentials button.
6. On the confirmation screen, click Ok. The system displays the API credentials. These API credentials will not work till you click the Submit button and complete the process of generating API credentials.
   
7. Click the Submit button.

5. Authenticate yourself

1. Navigate to the SAFE API portal.
2. Click the Authorize button.
3. In the basicAuth section, enter the Username and Password generated from SAFE. Refer to the Generate API Credentials section.
4. Click the Authorize button. Now you can use the SAFE REST APIs.

6. FAQs

1. How is the API data structured?
   All API data is structured using JSON for both Request and Response objects. Examples are available in the Swagger documentation.
2. How will API keys be generated (access, write, and/or read keys)?
   API keys are only available for the Admin role in SAFE. They are generated in the UI and shown on the screen once. These keys have both read/write permissions.
3. What kind of API request limits are we limited to?
   API requests are capped at 1200 requests/min.
4. How are API versions handled?
   The APIs versioning is done using versions API endpoints for, e.g.,/api/v3/assets.