Accessing SAFE APIs

  • 1 minute(s) read

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 different technologies depending on your needs and existing infrastructure. The SAFE REST API can add additional context to other security tools by extracting data from SAFE.

Access SAFE APIs

To access the SAFE REST APIs:

  1. Click the User Profile, which is available at the top-right of the screen.

  2. Click the Help option and then click the SAFE API option. You will be redirected to the SAFE API portal.

    accessing_api.png

SAFE REST API Documentation Portal

SAFE API documentation is available on Swagger. Swagger is an Interface Description Language for describing RESTful APIs using JSON. Once you access the SAFE REST APIs portal, authentication is required to use the APIs.

Generate API Credentials

To generate the SAFE API credentials:

  1. Navigate to Settings > API Credentials.

  2. Click the Add API Credential button.

  3. The system displays the API Username and API Password.

  4. Copy the API Username and API Password before clicking Done. The system displays the API credentials only once.

  5. Click the Done button.
    apitoken_creation.png

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.

  4. Click the Authorize button. Now you can use the SAFE REST APIs.

Delete API Credentials

  1. Login to SAFE.

  2. Navigate to Settings > API Credentials.

  3. Click the three-dot options and then the delete option for a API credentials.

Edit API Credentials

  1. Login to SAFE.

  2. Navigate to Settings > API Credentials.

  3. Click the three-dot options and then the edit option for a API credentials.

  4. You can only change the name of the API credential. Chnage the name and save.

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 API versioning is done using versions API endpoints for, e.g.,/api/v3/assets.