How to Generate Access Keys?

How to Generate Access Keys?

Overview

This article provides a comprehensive overview of how to generate access keys for the Developer Portal APIs. Users can generate two types of access keys:

  • Partial Access Key: This key allows users to provide access to specific APIs, giving them control over which APIs they want to grant access to.
  • Full Access Key: This key provides access to all the APIs available in the Developer Portal, offering unrestricted access.

With these access keys, users can easily manage and control API access based on their needs.

Pre-requisites

Access to the below mentioned permission on the Meritto portal:

  1. Access to Account Setup
  2. Access to API Keys

Steps to Generate the Access Keys

Step 1: Click on the Settings Configuration, which is highlighted in yellow in the screenshot below.

 

Step 2: Navigate to Account Setup in the left vertical panel, then go to API Keys in the right horizontal panel.

Step 3: Click on Create Access Key if a new key needs to be generated, or click on the down arrow button if any updates need to be made to an already generated key.

 

Step 4: Define Title for the API key Management

Step 5: Define the Setup Access as either Enable Full Access or Enable Partial Access:

  • Enable Full Access: When selected, the user will have access to all APIs associated with the particular Access Key.
  • Enable Partial Access: When selected, the user must choose specific APIs to grant access to. For Form, Application, and Payment APIs, users must select the form for which data needs to be fetched or updated.

Step 6: Define the Start Date and End Date of the API as follows:

  • Start Date: The date from which the API access will be active and operational.
  • End Date: The date after which the API access will be deactivated or expired.

Step 7: Define the IPs if you wish to enable partial access for specific IPs. This allows you to restrict API access to certain IP addresses. Simply enter the IP addresses that should have access to the API when partial access is enabled.

The Access Key for the developer portal API has been successfully generated. You're all set!

Conclusion

You can easily generate and manage API access keys in the Meritto Developer Portal, with options for full or partial access. Once configured, the access keys enable secure and controlled integration with Meritto’s APIs.