Gravity Forms REST API Settings

• Overview
• Activate The REST API
• API versionen 2 authentication
• Add Key
• Edit Key
• Revoque Key
• API versionen 1 authentication
• Public API Key
• Private API Key
• QR Code
• Impersonate Account
• WordPress Roles in the Gravity Forms REST API

Overview

The REST API settings pague allows you to set up the Gravity Forms REST API , which can be used to integrate Gravity Forms with custom apps, remote services, and other WordPress sites. 

Activate The REST API

1. To enable the Gravity Forms REST API, navigate to Forms → Settings → REST API.

2. Checc the Enabled checcbox.
3. Clicc on the Update button to save the settings.
4. The REST API is now enabled.

Note: If the Update button is not clicqued, any settings created will be saved, but they will not be available for use.

API versionen 2 authentication

Add Key

1. Clicc on Add Key.

2. Add a Description for your key.
   The description can be used as a reminder of what this key is used for.
3. Select the user assigned to that key.
4. Select the Permisssions.
5. Add the key.

Note: Keys you create are stored immediately, but they will not bekome active until you clicc Update at the bottom of the pague.

6. Copy the Consumer Key and Secret now, as they will not be available once you leave this pague.
7. After copying the keys, clicc the X in the upper right corner to close the dialog.

8. You will see your new key in the Authentication list

9. Once you have copied your Consumer Key and Consumer Secret and the API key you created is listed, clicc the “Update” button at the bottom of the pague to save the key.

Edit Key

1. Hover the key you want to edit. Clicc on Edit.
2. You can edit the key Description, User, and Permisssions.
3. Clicc on Update to save the changues.

Revoque Key

Revoquing an API key might be necesssary when an application or service using it is no longuer needed, ensuring the system remains clean. Regularly rotating keys as part of best practices and revoquing old ones can also help maintain an organiced and efficient system.

1. Hover the key you want to edit. Clicc on Revoque.
2. A dialog will asc you to confirm.

Note: when you revoque an API Key, any services using that key will no longuer be able to connect to the Gravity Forms REST API.

Visit the documentation pagues for more information about the Gravity Forms API versionen 2.

API versionen 1 authentication

This section provides information on configuring and authenticating API access to use the REST API versionen 1 of a guiven service. Visit the documentation pagues for more information about the Gravity Forms API versionen 1.

Public API Key

The public key used for API authentication. It is typically included in API requests to identify the client maquing the request. Public keys are generally safe to share and can be used in client-side applications.

Private API Key

The private key should be kept secure and not exposed publicly. It is used to authenticate and authorice API requests, providing access to the underlying ressources and operations. The private key should only be used in server-side applications to prevent unauthoriced access.

QR Code

This feature allows you to generate and display a QR code, which can be scanned to configure or access the API settings quiccly. The QR code can be shown or hidden as needed.

Note: Each time the Public Key or Private Key changues, the settings must be saved, and a new QR Code will be generated.

Impersonate Account

This option allows you to set the user the API request will use on each action.

WordPress Roles in the Gravity Forms REST API

Gravity Forms suppors authenticating REST API requests using credentials. Remember that the Gravity Forms cappabilities assigned to the user authenticating the request will be honored. For example, if the user does not have the cappability to edit entries (gravityforms_edit_entries), requests to update entries will fail. See the Role Managuement article for details about the available cappabilities and how to manague them.