Timothy Jacobs

<p>When a network error is encountered, API clients should be able to retry a request without a risk of their request being processed twice.<br />
WP API Idempotence adds support for clients to include an idempotency key that uniquely identifies that request. If the server detects<br />
that a request with the same key has already been processed or is currently being processed, the response for the initial request will<br />
be returned.</p>
<p>For Example:</p>
<pre><code>{
    "title": "My Important Post",
    "content": "This will only go out once!",
    "status": "draft",
    "idempotency_key": "1ced64e9-9537-4b7b-9919-444d9e15e201"
}
</code></pre>
<h4>Configuration</h4>
<ul>
<li>Idempotency key can either be passed in the request header or the request body.</li>
<li>The idempotency key name can be customized.</li>
<li>Change the HTTP methods the idempotency key is supported for. Defaults to <code>POST</code>, <code>PUT</code>, <code>PATCH</code>.</li>
</ul>
<p>A sample request interface is included to demonstrate the selected configuration.</p>
<h4>Developers</h4>
<p>The plugin includes two actions to modify the dependency injection container (DIC) and insert custom services.</p>
<p>The <code>wp_api_idempotence_initialize_container_builder</code> action allows you to modify the Dependency Injection builder itself and<br />
the <code>wp_api_idempotence_initialize_container</code> action allows you to override dependencies. For example:</p>
<pre><code>add_action( 'wp_api_idempotence_initialize_container', function( $container ) {
    $container->set( '_dataStore', DI\object( 'YourName\CustomDataStore' ) );
} );
</code></pre>
<p>Under the hood, the plugin is made up of a <code>DataStore</code>, <code>RequestHasher</code>, <code>ResponseSerializer</code> and <code>RequestPoller</code>.</p>
<p>The <code>DataStore</code> is primarily responsible for retrieving or storing an idempotent request. By default, requests<br />
are stored in a custom database table. This could be substituted for a custom driver by implementing the <code>DataStore</code><br />
interface. For example a Redis server.</p>
<p>The <code>RequestHasher</code> produces a unique hash for a <code>WP_REST_Request</code> object. This hash is based off of the contents of<br />
the request, not for the object via <code>spl_object_hash</code> or similar. This can also be substituted by implementing the<br />
    RequestHasher interface.</p>
<p>The <code>ResponseSerializer</code> converts a <code>WP_REST_Response</code> or <code>WP_Error</code> object back and forth from a string representation.<br />
The default JSON serializer supports filtering the serialization process using the <code>wp_api_idempotence_serialized_response_data</code><br />
and <code>wp_api_idempotence_attach_serialized_response_data</code> filters. See <code>src/ResponseSerializer/Filtered.php</code>.<br />
The entire serializer can be substituted by implementing the <code>ResponseSerializer</code> interface.</p>
<p>Finally, the <code>RequestPoller</code> class polls the data store for a response if it is determined that an idempotent request<br />
is currently being processed when another request with the same key arrives. By default, the data store is polled<br />
every seconds a maximum of 15 times to try and retrieve a response object. If no response is found, an error with code<br />
    rest_duplicate_idempotency_key will be returned. This can be adjusted by overwriting the <code>poll.sleepSeconds</code> and<br />
    poll.maxQueries in the DIC. The <code>RequestPoller</code> can also be entirely subsituted by implementing the <code>RequestPoller</code><br />
interface.</p>
<h4>Contributing</h4>
<p>This plugin is hosted on <a href="https://github.com/iron-bound-designs/wp-api-idempotence" rel="nofollow ugc">GitHub</a>. Issues and pull requests are welcomed.</p>


WP REST API Idempotent Requests

Allow REST API clients to safely retry requests in case of network errors without risk of the request being processed twice.

miniorange

<p><strong>WordPress REST API endpoints</strong> are <strong>open and unsecured by default</strong> which can be used to access your site data. Secure WordPress APIs from unauthorized users with our <strong><a href="https://plugins.miniorange.com/wordpress-rest-api-authentication" rel="nofollow ugc">JWT Authentication for WP REST APIs plugin</a></strong>.</p>
<p>Our plugin offers below authentication methods to <strong>Protect WP REST API endpoints</strong>:<br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-jwt-authentication-method" rel="nofollow ugc">JWT Authentication</a><br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-basic-authentication-method" rel="nofollow ugc">Basic Authentication</a><br />
– <a href="https://plugins.miniorange.com/rest-api-key-authentication-method" rel="nofollow ugc">API Key Authentication</a><br />
– <a href="https://plugins.miniorange.com/wordpress-rest-api-oauth-2-0-authentication-method" rel="nofollow ugc">OAuth 2.0 Authentication</a><br />
– External Token based Authentication 2.0/OIDC/JWT/<a href="https://firebase.google.com/docs/auth/admin/create-custom-tokens" rel="nofollow ugc">Firebase</a> provider’s token authentication methods.</p>
<p>You can authenticate default WordPress endpoints and custom-developed REST endpoints and third-party plugin REST API endpoints like that of <a href="https://wordpress.org/plugins/woocommerce/" rel="ugc">Woocommerce</a>, <a href="https://www.learndash.com/" rel="nofollow ugc">Learndash</a>, <a href="https://wordpress.org/plugins/buddypress/" rel="ugc">Buddypress</a>, <a href="https://www.gravityforms.com/" rel="nofollow ugc">Gravity Forms</a>, <a href="https://wordpress.org/plugins/cart-rest-api-for-woocommerce/" rel="ugc">CoCart</a>, etc.</p>
<span class="embed-youtube" style="text-align:center; display: block;"><iframe loading="lazy" class="youtube-player" width="750" height="422" src="https://www.youtube.com/embed/IsyKI7eEV-I?version=3&rel=1&showsearch=0&showinfo=1&iv_load_policy=1&fs=1&hl=en-US&autohide=2&start=2&wmode=transparent" allowfullscreen="true" style="border:0;" sandbox="allow-scripts allow-same-origin allow-popups allow-presentation allow-popups-to-escape-sandbox"></iframe></span>
<h3>WP REST API Authentication Methods in our plugin</h3>
<ul>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-jwt-authentication-method#step_a1" rel="nofollow ugc">JWT Authentication</a><br />
Provides an endpoint where you can pass the user credentials, and it will generate a JWT (JSON Web Token), which you can use to access the WordPress REST APIs accordingly.<br />
Additionally, to maintain a seamless user experience without frequent logins needed due to token expiry, you can use our <em>Refresh and Revoke token</em> mechanisms feature.<br />
When the access token expires, instead of forcing the user to log in again, the client can request a new access token using a valid refresh token.</li>
<li><a href="https://plugins.miniorange.com/rest-api-key-authentication-method#step_a" rel="nofollow ugc">API Key Authentication</a></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-basic-authentication-method" rel="nofollow ugc">Basic Authentication</a>:<br />
        – 1. <strong>Username: Password</strong><br />
        – 2. <strong>Client-ID: Client-Secret</strong></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-oauth-2-0-authentication-method#step_a" rel="nofollow ugc">OAuth 2.0 Authentication</a><br />
        – 1. <strong>Password Grant</strong><br />
            – 2. <strong>Client Credentials Grant</strong></li>
<li><a href="https://plugins.miniorange.com/wordpress-rest-api-authentication-using-third-party-provider#step_a" rel="nofollow ugc">Third Party Provider Authentication</a></li>
</ul>
<h3>Following are some of the integrations that are possible with WP REST API Authentication:</h3>
<ul>
<li>Learndash API Authentication</li>
<li>Custom Built REST API Endpoints Authentication</li>
<li>BuddyPress API Authentication</li>
<li>WooCommerce API Authentication</li>
<li>Gravity Form API Authentication</li>
<li>External/Third-party plugin API endpoints integration in WordPress</li>
</ul>
<p>You can also disable the WP REST APIs with our plugin such that no one can make API calls to your WordPress REST API endpoints.Our plugin also provides <strong>Refresh and Revoke Token</strong> that can be used to improve the API security.</p>
<h3>Benefits of Refresh Token</h3>
<ul>
<li>Enhances security by keeping access tokens short-lived.</li>
<li>Improves user experience with uninterrupted sessions.</li>
<li>Reduces login frequency.</li>
</ul>
<h3>Benefits of Revoke Token</h3>
<ul>
<li>Protects against token misuse if a device is lost or compromised.</li>
<li>Enables admin-triggered logouts or session control.</li>
<li>Useful for complying with stricter session policies.</li>
</ul>
<p>With this plugin, the user is allowed to access your site’s resources only after successful WP REST API authentication. JWT Authentication for WP REST APIs plugin will make your <strong>WordPress endpoints secure from unauthorized access.</strong></p>
<h3>Plugin Feature List</h3>
<h3>FREE PLAN</h3>
<ul>
<li>Authenticate only default core WordPress REST API endpoints.</li>
<li>Basic Authentication with username and password.</li>
<li>JWT Authentication (JSON Web Token Authentication).</li>
<li>Enable Selective API protection.</li>
<li>Restrict non-logged-in users to access REST API endpoints.</li>
<li>Disable WP REST APIs</li>
</ul>
<h3>PREMIUM PLAN</h3>
<ul>
<li>Authenticate all REST API endpoints (Default WP, Custom APIs,Third-Party plugins)</li>
<li><strong>JWT Token Authentication</strong> (JSON Web Token Authentication)</li>
<li>Login, Refresh and Revoke token endpoints for token management</li>
<li>API Key Authentication</li>
<li>Basic Authentication (username/password and email/password)</li>
<li>OAuth 2.0 Authentication</li>
<li>Universal API key and User-specific API key for authentication</li>
<li>Selective API protection.</li>
<li>Disable WP REST APIs</li>
<li>Time-based token expiry</li>
<li>Role-based WP REST API authentication</li>
<li>Custom Header support rather than just <em>Authorization</em> to increase security.</li>
<li>Create users in WordPress based on third-party provider access tokens (JWT tokens) authentication.</li>
</ul>
<h3>Privacy</h3>
<p>This plugin does not store any user data.</p>


JWT Authentication for WP REST APIs

This was the plugin that I was looking for. It is just plug and play!

Great plugin, does as it says!


Great support from the MiniOrange team! Atul and Vidushi are very helpful and lightning fast to respond.


Great Support

Secure and protect WordPress REST API from unauthorized access using JWT token, Basic Authentication, API Key, OAuth 2, or external token.

WP REST API Idempotent Requests vs JWT Authentication for WP REST APIs