Skip to main content

Authorization

Follow this guide to create a new WordPress credential that will allow Nexla to authenticate to and exchange data with your WordPress site.
wordpress_api_auth.png

WordPress

Prerequisites​

Before creating a WordPress credential, you'll need to obtain authentication credentials from your WordPress site. WordPress REST API supports multiple authentication methods, including Basic Authentication with Application Passwords (recommended) or no authentication for public endpoints.

To obtain WordPress API credentials:

  1. Log in to your WordPress admin dashboard. Navigate to your WordPress site's admin panel (typically at https://yoursite.com/wp-admin).

  2. For Basic Authentication with Application Passwords (recommended for secure access):

    • Navigate to Users > Profile or Users > All Users and select your user account.
    • Scroll down to the Application Passwords section.
    • Enter a name for the application password (e.g., "Nexla Integration").
    • Click Add New Application Password.
    • Copy the generated application password immediately, as it will only be displayed once. This is a 24-character password that you'll use along with your username.

  3. Note your WordPress Site URL. This is the full URL to your WordPress site, including the protocol (https://), such as https://yoursite.com.

  4. Note your WordPress Username. This is the username you use to log in to your WordPress admin dashboard.

  5. Note your WordPress API Version. The default API version is typically v2, but this may vary depending on your WordPress version. The WordPress REST API is available at /wp-json/wp/{version}/.

WordPress REST API supports multiple authentication methods. For secure access to protected endpoints, use Basic Authentication with Application Passwords. Application Passwords are more secure than regular passwords and can be revoked individually. For public endpoints (like reading public posts), you may not need authentication. However, for most operations, Basic Authentication with Application Passwords is recommended.

For detailed information about WordPress REST API authentication and Application Passwords, refer to the WordPress REST API Handbook and WordPress Application Passwords Documentation.

Create a WordPress Credential​

  • To create a new WordPress credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – WordPress

WordPressCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Credential Settings​

  1. In the WordPress Site URL field, enter the full URL to your WordPress site, including the protocol (https://). For example, https://yoursite.com. Do not include a trailing slash.

  2. If using Basic Authentication (recommended for secure access):

    • In the Username field, enter your WordPress username. This is the username you use to log in to your WordPress admin dashboard.
    • In the Password field, enter your WordPress Application Password (not your regular WordPress password). This is the 24-character application password you generated in your WordPress user profile.

  3. In the Version field, enter the WordPress API version. The default value is v2, which is the standard version for WordPress REST API.

    If you're using Basic Authentication, use an Application Password (not your regular WordPress password) for security. Application Passwords can be revoked individually and are more secure for API access. If you're only accessing public endpoints, you may not need authentication, but Basic Authentication is recommended for most operations.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.