REST API v2 Basic Authentication

• Overview
• Authentication Credentials
• Gravity Forms
• WordPress Application Passwords
• Examples
• Postman
• PHP Example

Note: OAuth 1.0a is the recommended authentication method as it offers a higher level of security. Refer to this article for more information.

Overview

Use this guide to authenticate requests to the Gravity Forms REST API v2 with Basic Authentication. Basic Auth is supported only over HTTPS.

Requests execute with the authenticated user’s Gravity Forms capabilities, so ensure the user has the permissions required for each endpoint.

Authentication Credentials

Gravity Forms

Credentials can be created via the Forms > Settings > REST API page. Refer to the documentation to create your API Keys.

WordPress Application Passwords

WordPress added support for Application Passwords in version 5.6. Starting with Gravity Forms 2.4.21.4 you can use WordPress Application Passwords.

To create an Application Password with WordPress 5.6 or greater go to your profile page in the WordPress admin (/wp-admin/profile.php) and scroll towards the end of the page.

Enter a name in the “New Application Password Name” input and then click the “Add New Application Password” button. WordPress will generate and display the password which you can use to authenticate requests to the REST API.

When using this Application Password with Basic Authentication, use your account username or email address as the username.

Examples

The following are a few examples of requests with Basic Authentication.

Postman

Postman is a free app that allows you to send API requests easily without writing any code. Download it here

PHP Example

$username = 'ck_c8d98772e0f4db070c97416796ff251fc991f454';
$password = 'cs_e0665f1acf0460581ab4fdce978404b28dab1a54';

$headers  = array( 'Authorization' => 'Basic ' . base64_encode( "{$username}:{$password}" ) );
$response = wp_remote_get( 'https://gravityforms.local/wp-json/gf/v2/entries/5', array( 'headers' => $headers ) );

// Check the response code.
if ( wp_remote_retrieve_response_code( $response ) != 200 || ( empty( wp_remote_retrieve_body( $response ) ) ) ) {
	// If not a 200, HTTP request failed.
	die( 'There was an error attempting to access the API.' );
}