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.

David Anderson / Team Updraft

Prashant Baldha

DNutbourne

aporter

Venkat Raj

WPGetAPI

<p>Connect WordPress to external APIs, without code.</p>
<p>Easily send data to any API and get data from unlimited 3rd party REST APIs. Format and display the returned data on your WordPress website using a shortcode or a template tag.</p>
<p><iframe loading="lazy" title="Quick intro to WPGetAPI" width="750" height="422" src="https://www.youtube.com/embed/X50qINEs1yo?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></p>
<p>WPGet API supports virtually all authentication methods including API keys, bearer tokens, basic auth, username/password and <a href="https://wpgetapi.com/downloads/oauth-2-0-authentication/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">OAuth 2.0 authorization</a>.</p>
<h3>Live Examples</h3>
<p>View our live examples of connecting to several different APIs and displaying the data in various unique ways including charts, graphs, tables and weather forecasts.</p>
<p><a href="https://wpgetapi.com/demo-connecting-wordpress-to-external-api/?utm_campaign=Demo&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">LIVE EXAMPLES – Connecting WordPress to external APIs</a></p>
<h3>Major Features</h3>
<ul>
<li>Connect your WordPress website to any REST API</li>
<li>Unlimited APIs & endpoints</li>
<li>No coding required</li>
<li>Display API data using a template tag or shortcode</li>
<li>GET, POST, PUT, PATCH & DELETE methods</li>
<li>Add query string, header & body parameters</li>
</ul>
<h3>Documentation</h3>
<p>We have tons of articles and help available.</p>
<ul>
<li><a href="https://wpgetapi.com/docs/quick-start-guide/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Quick Start Guide</a></li>
<li><a href="https://wpgetapi.com/docs/step-by-step-example/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Step by Step Example</a></li>
<li><a href="https://wpgetapi.com/docs/frequently-asked-questions/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Frequently Asked Questions</a></li>
<li><a href="https://wpgetapi.com/docs/will-this-work-with-my-api/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Will this work with my API?</a></li>
</ul>
<h3>Extending WPGet API</h3>
<h4>PRO Plugin</h4>
<p>The <strong><a href="https://wpgetapi.com/downloads/pro-plugin/?utm_campaign=Pro&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">PRO Plugin</a></strong> provides many extra features that allow you to do some more advanced things with your APIs. Features of the PRO Plugin include:</p>
<ul>
<li>Actions – automate your API when an action happens on your site</li>
<li>Tokens – grab dynamic data without code and send to your API</li>
<li>Dynamic variables – a PHP solution for grabbing dynamic values</li>
<li>Chain API calls</li>
<li>Cache API calls</li>
<li>Format API data into HTML</li>
<li>Retrieve nested data</li>
<li>Base64 encoded auth</li>
<li>XML format</li>
</ul>
<h4>API to Posts Plugin</h4>
<p>The <strong><a href="https://wpgetapi.com/downloads/api-to-posts/?utm_campaign=APItoPosts&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">API to Posts Plugin</a></strong> allows you to import API data and create WooCommerce products or custom posts from this API data. Features of the API to Posts Plugin include:</p>
<ul>
<li>Import API data</li>
<li>Import from unlimited endpoints</li>
<li>Map API data to WordPress fields</li>
<li>Supports custom fields, ACF, tags, categories, custom taxonomies, images and more</li>
<li>Supports all standard WooCommerce fields</li>
<li>Create WooCommerce products from API data</li>
<li>Sync API to WooCommerce products & posts</li>
<li>Set interval of sync from every minutes up to once a week</li>
</ul>
<h4>OAuth 2.0 Authorization</h4>
<p>The <strong><a href="https://wpgetapi.com/downloads/oauth-2-0-authentication/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">OAuth 2.0 Authorization</a></strong> plugin allows authorization of your API through the OAuth 2.0 method.</p>
<h3>WPGet API Integrations</h3>
<p>WPGet API integrates extremely well with other WordPress plugins, allowing you to do some very cool things with your API. Click the links below for more info on these integrations.</p>
<ul>
<li><a href="https://wpgetapi.com/docs/connect-woocommerce-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">WooCommerce to API</a></li>
<li><a href="https://wpgetapi.com/docs/woocommerce-api-product-sync/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">WooCommerce API Product Sync</a></li>
<li><a href="https://wpgetapi.com/docs/send-contact-form-7-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Contact Form 7 send data to API</a></li>
<li><a href="https://wpgetapi.com/docs/send-wpforms-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">WPForms send data to API</a></li>
<li><a href="https://wpgetapi.com/docs/send-gravity-forms-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Gravity Forms send data to API</a></li>
<li><a href="https://wpgetapi.com/docs/using-with-wpdatatables/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme" rel="nofollow ugc">Charts & Tables from API data using wpDataTables</a></li>
</ul>
<h3>Translating WPGet API</h3>
<p>You can translate WPGet API into your own language on <a href="https://translate.wordpress.org/projects/wp-plugins/wpgetapi/" rel="nofollow ugc">translate.wordpress.org</a></p>
<p>Here is an article to help <a href="https://make.wordpress.org/polyglots/handbook/translating/first-steps/" rel="nofollow ugc">get started with translations</a></p>


WPGet API – Connect to any external REST API

Connect any REST API to WordPress. WPGet API enables easy API integration, allowing you to display API data without any code.

WP REST API Idempotent Requests vs WPGet API – Connect to any external REST API