PluginProbe
WPGet API – Connect to any external REST API / 2.2.3
WPGet API – Connect to any external REST API v2.2.3
1.9.2 1.9.3 1.9.4 1.9.5 1.9.6 1.9.7 1.9.8 1.9.9 2.0.0 2.0.1 2.0.2 2.0.3 2.0.4 2.0.5 2.0.6 2.1.0 2.1.1 2.1.3 2.1.4 2.1.5 2.2.0 2.2.1 2.2.10 2.2.2 2.2.3 All 97 releases
wpgetapi / readme.txt

readme.txt in WPGet API – Connect to any external REST API 2.2.3, at readme.txt

489 lines 20.1 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 === Connect to external APIs - WPGetAPI ===
2 Contributors: wpgetapi
3 Tags: api, external api, json, endpoint, rest, woocommerce
4 Requires at least: 5.0
5 Requires PHP: 7.0
6 Tested up to: 6.4
7 Stable tag: 2.2.3
8 License: GPLv2 or later
9 License URI: http://www.gnu.org/licenses/gpl-2.0.html
10
11 Connect WordPress to external APIs. Send your data to APIs and display API data using shortcode or template tag. Connecting to APIs has never been easier.
12
13 == Description ==
14
15 Connect WordPress to external APIs, without code.
16
17 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.
18
19 https://www.youtube.com/watch?v=X50qINEs1yo
20
21 WPGetAPI supports virtually all authentication methods including API keys, bearer tokens, basic auth, username/password and [OAuth 2.0 authorization](https://wpgetapi.com/downloads/oauth-2-0-authentication/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme).
22
23 ### Live Examples
24
25 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.
26
27 [LIVE EXAMPLES - Connecting WordPress to external APIs](https://wpgetapi.com/demo-connecting-wordpress-to-external-api/?utm_campaign=Demo&utm_medium=wporg&utm_source=readme)
28
29 ### Major Features
30
31 * Connect your WordPress website to any REST API
32 * Unlimited APIs & endpoints
33 * No coding required
34 * Display API data using a template tag or shortcode
35 * GET, POST, PUT, PATCH & DELETE methods
36 * Add query string, header & body parameters
37
38 ### Documentation
39
40 We have tons of articles and help available.
41
42 * [Quick Start Guide](https://wpgetapi.com/docs/quick-start-guide/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme)
43 * [Step by Step Example](https://wpgetapi.com/docs/step-by-step-example/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme)
44 * [Frequently Asked Questions](https://wpgetapi.com/docs/frequently-asked-questions/?utm_campaign=Docs&utm_medium=wporg&utm_source=readme)
45 * [Will this work with my API?](https://wpgetapi.com/docs/will-this-work-with-my-api/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme)
46
47 ### Extending WPGetAPI
48
49 = PRO Plugin =
50 The **[PRO Plugin](https://wpgetapi.com/downloads/pro-plugin/?utm_campaign=Pro&utm_medium=wporg&utm_source=readme)** provides many extra features that allow you to do some more advanced things with your APIs. Features of the PRO Plugin include:
51
52 * Actions - automate your API when an action happens on your site
53 * Tokens - grab dynamic data without code and send to your API
54 * Dynamic variables - a PHP solution for grabbing dynamic values
55 * Chain API calls
56 * Cache API calls
57 * Format API data into HTML
58 * Retrieve nested data
59 * Base64 encoded auth
60 * XML format
61
62
63 = API to Posts Plugin =
64 The **[API to Posts Plugin](https://wpgetapi.com/downloads/api-to-posts/?utm_campaign=APItoPosts&utm_medium=wporg&utm_source=readme)** 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:
65
66 * Import API data
67 * Import from unlimited endpoints
68 * Map API data to WordPress fields
69 * Supports custom fields, ACF, tags, categories, custom taxonomies, images and more
70 * Supports all standard WooCommerce fields
71 * Create WooCommerce products from API data
72 * Sync API to WooCommerce products & posts
73 * Set interval of sync from every minutes up to once a week
74
75
76 = OAuth 2.0 Authorization =
77 The **[OAuth 2.0 Authorization](https://wpgetapi.com/downloads/oauth-2-0-authentication/?utm_campaign=OAuth&utm_medium=wporg&utm_source=readme)** plugin allows authorization of your API through the OAuth 2.0 method.
78
79
80 ### WPGetAPI Integrations
81
82 WPGetAPI 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.
83
84
85 * [WooCommerce to API](https://wpgetapi.com/docs/connect-woocommerce-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme)
86 * [WooCommerce API Product Sync](https://wpgetapi.com/docs/woocommerce-api-product-sync/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme)
87 * [Contact Form 7 send data to API](https://wpgetapi.com/docs/send-contact-form-7-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme)
88 * [WPForms send data to API](https://wpgetapi.com/docs/send-wpforms-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme)
89 * [Gravity Forms send data to API](https://wpgetapi.com/docs/send-gravity-forms-data-to-api/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme)
90 * [Charts & Tables from API data using wpDataTables](https://wpgetapi.com/docs/using-with-wpdatatables/?utm_campaign=Integrations&utm_medium=wporg&utm_source=readme)
91
92
93 ### Translating WPGetAPI
94
95 You can translate WPGetAPI into your own language on [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/wpgetapi/)
96
97 Here is an article to help [get started with translations](https://make.wordpress.org/polyglots/handbook/translating/first-steps/)
98
99 == Installation ==
100 = Requirements =
101 * WordPress version 5.0 and later
102 * PHP 7.2, Tested with PHP 8.2
103 * cURL
104
105 = Usage =
106
107 1. Go to the `WPGetAPI -> Setup` menu to add your APIs.
108 2. Once your APIs are saved, a new tab is created allowing you to add endpoints.
109 3. Once your endpoints are saved, you can use the template tag or shortcode to connect to your API and view the data.
110
111 == Frequently Asked Questions ==
112
113
114 = Is WPGetAPI free? =
115
116 Yes, WPGetAPI’s core features are free and will always be free.
117
118 The [PRO version](https://wpgetapi.com/downloads/pro-plugin/?utm_campaign=PRO&utm_medium=wporg&utm_source=faq) is an extension that adds extra features if you are looking to do more with your API.
119
120 The [API to Posts plugin](https://wpgetapi.com/downloads/api-to-posts/?utm_campaign=APItoPosts&utm_medium=wporg&utm_source=faq) is an extension that allows you to create posts or products from your API data.
121
122
123 = Can I connect to any REST API? =
124
125 Yes, most likely. WPGetAPI handles all major methods of authorization and authentication. It will depend on the type of authentication your API is using. Please click the link to view the [types of authentication and authorization](https://wpgetapi.com/docs/authentication-authorization/?utm_campaign=Docs&utm_medium=wporg&utm_source=faq) that are available.
126
127
128 = Can I capture form data and send to my API? =
129
130 Yes, see [this article](https://wpgetapi.com/docs/send-form-data-to-api/?utm_campaign=Form&utm_medium=wporg&utm_source=faq) on how you can capture data from your forms and send the data to your API.
131
132 This is perfect for lead generation forms, contact forms or really any other type form that requires you to send form data to an API.
133
134
135 = Can I use an XML based API? =
136
137 Yes, we support XML with our [PRO Plugin](https://wpgetapi.com/downloads/pro-plugin/?utm_campaign=Pro&utm_medium=wporg&utm_source=faq)
138
139
140 = How do I connect WordPress to an API? =
141
142 By using this plugin of course! Check out the video at the top of this page or visit our [Quick Start Guide](https://wpgetapi.com/docs/quick-start-guide/?utm_campaign=Quick-Start&utm_medium=wporg&utm_source=faq) to get started with connecting your WordPress website with an API.
143
144
145 = How do I cache API calls? =
146
147 We support caching with our [PRO Plugin](https://wpgetapi.com/downloads/pro-plugin/?utm_campaign=Pro&utm_medium=wporg&utm_source=faq). It also recognises dynamic queries and will cache these individually.
148
149 A dynamic query might be something like these:
150
151 /customer-endpoint/customer?user_id=123
152 /customer-endpoint/customer?user_id=4567
153
154 The PRO plugin recognises that whilst they are the same endpoint, they are different queries that need to be cached separately.
155
156 = Where can I find docs? =
157
158 All of our [documentation can be found here](https://wpgetapi.com/docs/quick-start-guide/?utm_campaign=Docs&utm_medium=wporg&utm_source=faq).
159
160
161 = What can I do with the API data? =
162
163 The API data can be output as a JSON string, stored in a PHP variable or automatically output as HTML (using PRO plugin). You can easily format the data into tables or charts plus many other possibilities.
164
165
166 = Will you help me if I am having trouble? =
167
168 Yes! Please [visit our website](https://wpgetapi.com/?utm_campaign=Contact&utm_medium=wporg&utm_source=faq) and create a support ticket. We will help you to get your API up and running.
169
170
171 = How do I create WooCommerce products from API data? =
172
173 You can create WooCommerce products from API data (sync API to WooCommerce products) using our [API to Posts Plugin](https://wpgetapi.com/downloads/api-to-posts/?utm_campaign=APItoPosts&utm_medium=wporg&utm_source=faq)
174
175
176 = How do I create custom posts from API data? =
177
178 You can create custom posts from API data (sync API to custom posts) using our [API to Posts Plugin](https://wpgetapi.com/downloads/api-to-posts/?utm_campaign=APItoPosts&utm_medium=wporg&utm_source=faq)
179
180
181 == Screenshots ==
182
183 1. The Setup screen where you can add your external APIs
184 2. Once an external API has been added, a new page will be created to setup the API endpoints
185 3. A live demo of the output when debug mode is set to true
186 4. An example of some raw output from an API
187 5. Basic example of the output from an API formatted into HTML table
188
189
190 == Changelog ==
191
192 = 2.2.3 (2023-10-05) =
193 - Fix - plugin conflict with Rank Math SEO making the 'Test Endpoint' button unavailable.
194
195 = 2.2.2 (2023-10-02) =
196 - Fix - vulnerability when importing endpoints: https://www.pluginvulnerabilities.com/2023/09/07/our-proactive-monitoring-caught-an-authenticated-option-update-vulnerability-being-introduced-in-to-wpgetapi/
197
198 = 2.2.1 (2023-10-02) =
199 - Fix - add check if not array data in cURL error section.
200
201 = 2.2.0 (2023-09-28) =
202 - Update - Big UI update.
203 - Update - Add cURL errors to test endpoint section.
204 - New - Add timeout option to admin.
205 - New - Set all wp_options autoload to 'no' for performance.
206
207 = 2.1.5 (2023-09-19) =
208 - Fix - move check for PRO plugin into init function rather than class construct.
209
210 = 2.1.4 (2023-09-19) =
211 - Fix - allow actions to passed when within a float(), integer(), or boolean() tag in admin for PRO plugin.
212
213 = 2.1.2 (2023-09-15) =
214 - Update - change Test Endpoint from 'a' tag to 'button' and disable it when new endpoint added and has not been saved.
215 - New - add new filter 'wpgetapi_xml_element' for modifying the opening XML element.
216 - Fix - override adding a border to .metabox-holder class that was being added by another plugin.
217
218 = 2.1.1 (2023-09-12) =
219 - New - add collapse button to toggle opening/closing of all endpoints.
220 - New - add new filter: wpgetapi_modify_formatted_body_parameters.
221 - New - add name of endpoint to endpoint title rather than 'Endpoint x'.
222 - New - add UTF-8 encoding to XML body.
223
224 = 2.1.0 (2023-09-06) =
225 - New - add import/export options.
226 - Update - minor CSS tweaks in admin.
227 - Update - modify the way CMB2 enqueues JS and CSS files.
228
229 = 2.0.6 (2023-08-22) =
230 - Update - add new shortcode attribute img_link to allow linking an image when using format='html'.
231
232 = 2.0.5 (2023-08-17) =
233 - New - add some minor checks to allow new API to Posts plugin to work.
234 - Update - modify error check codes to now capture all codes.
235
236 = 2.0.4 (2023-07-31) =
237 - Fix - float value not being formatted correctly.
238
239 = 2.0.3 (2023-07-26) =
240 - Fix - modify the check for json data being sent in parameters. Previously just looked for { } now looks for {" "}
241 - Update - minor styling updates to admin.
242 - New - add button for PRO plugin.
243
244 = 2.0.2 (2023-07-25) =
245 - Fix - only load css and js on wpgetapi pages.
246 - Fix - change reload time to 200ms and do the reload on all saving including endpoints.
247 - Update - add all available actions into actions field.
248 - New - add option to pass results_format from args.
249 - New - new styling for wpDataTables field.
250 - New - add JSON_PRETTY_PRINT as default.
251
252 = 2.0.1 (2023-07-19) =
253 - New - add new action field.
254 - Update - modify some help text.
255
256 = 2.0.0 (2023-07-18) =
257 - New - styling for actions field.
258 - Fix - force Unique ID fields to only be lowercase and underscores.
259
260 = 1.9.9 (2023-07-08) =
261 - Fix - bug with setting JSON encode when Body POST fields are empty.
262 - Update - changes to include Licenses page and text on that page.
263
264 = 1.9.8 (2023-07-05) =
265 - New - add ability to base64 encode body.
266
267 = 1.9.7 (2023-07-03) =
268 - Fix - reverse the last change as some APIs won't accept & values. Need to find better solution!
269
270 = 1.9.6 (2023-07-02) =
271 - New - add htmlentities function to full url to avoid changing anything to html entities.
272
273 = 1.9.5 (2023-06-30) =
274 - New - add PATCH request method.
275 - Udpate - allow BODY post fields with any request method.
276
277 = 1.9.4 (2023-06-22) =
278 - New - styling changes in admin. Remove input descriptions and replace with tooltips.
279 - Udpate - expand the info in many tooltips.
280
281 = 1.9.3 (2023-06-22) =
282 - New - add success and error messages when using the 'Test Endpoint' button in the admin.
283
284 = 1.9.2 (2023-06-12) =
285 - New - add new shortcode attributes for AJAX - button_id for adding an ID to the button and ajax_output for allowing to change the output div to whatever you like. This needs to be used like ajax_output="#my_div_with_id" or ajax_output="#my_div_with_class"
286
287 = 1.9.1 (2023-05-18) =
288 - Fix - error when trying to format XML as HTML.
289
290 = 1.9.0 (2023-05-18) =
291 - New - one-click copy buttons next to Template Tag and Shortcode.
292 - New - extra styling for WPGetAPI heading that also includes small icon and version number.
293
294 = 1.8.14 (2023-04-25) =
295 - Fix - error with setting encoding to JSON encode.
296
297 = 1.8.13 (2023-04-24) =
298 - Fix - issue when using multiple ajax buttons in PRO plugin.
299
300 = 1.8.12 (2023-04-21) =
301 - Fix - passing post id through ajax button for PRO plugin.
302
303 = 1.8.11 (2023-04-20) =
304 - Fix - Set chain_delay to 0 on WordPress admin to avoid loading delays in admin.
305
306 = 1.8.10 (2023-04-19) =
307 - New - Add ability to set a delay when chaining endpoints.
308
309 = 1.8.9 (2023-04-18) =
310 - Fix - Allow multidemsnional arrays when using x-www-formurlencoded
311
312 = 1.8.8 (2023-04-12) =
313 - Compatibility - Tested with WordPress 6.2.
314
315 = 1.8.7 (2023-03-24) =
316 - Enhancement - Allow raw string data to pass through output, rather than only JSON string data.
317
318 = 1.8.6 (2023-03-17) =
319 - New - Allow raw data in POST body fields.
320
321 = 1.8.5 (2023-03-16) =
322 - New - Add new format='no_display' shortcode attribute to stop any output from the API.
323 - New - Add new integration with chaining methods that can be used in conjuction with the PRO plugin.
324
325 = 1.8.4 (2023-03-01) =
326 - New - Add new integration with image attributes for the shortcode, to allow the display of images using the PRO plugin.
327
328 = 1.8.3 (2023-02-17) =
329 - New - Add ability to set value as boolean type.
330 - Fix - If format is set to HTML, then set the results format as PHP array to avoid having to do it in the settings.
331
332 = 1.8.2 (2023-02-14) =
333 - New - Integration for the new AJAX button in the PRO plugin.
334 - Fix - Allow both JSON string and PHP array format to work when format is set to HTML.
335
336 = 1.8.1 (2023-02-10) =
337 - Fix - Issue with nested JSON arrays within parameter values.
338 - Fix - Tidy up the wording of some fields and licensing page.
339
340 = 1.8.0 (2023-02-06) =
341 - New - Gutenberg block added.
342 - New - Admin styling updates.
343
344 = 1.7.11 (2023-02-03) =
345 - New - add ability of Pro plugin to send XML formatted data in Body POST fields.
346
347 = 1.7.10 (2023-01-30) =
348 - New - add new filter 'wpgetapi_should_we_stop' which allows us to not call the API if some condition is not met. Added to allow processing of Woocommerce tokens on successful order (Pro plugin only).
349 - New - add new attribute 'on'. Added to allow processing of Woocommerce tokens on successful order.
350
351 = 1.7.9 (2023-01-22) =
352 - Fix - fix the handling of arrays within parameters.
353
354 = 1.7.8 (2023-01-13) =
355 - New - add new licensing and updating methods.
356
357 = 1.7.7 (2023-01-10) =
358 - New - add ability to set float and integers within paramater settings using float(number) and integer(number) syntax.
359 - Fix - fix help link for Body paramters going to wrong page.
360
361 = 1.7.6 (2023-01-09) =
362 - Fix - fix error with DELETE not working.
363
364 = 1.7.5 (2023-01-09) =
365 - New - add DELETE method.
366
367 = 1.7.4 (2022-12-06) =
368 - Fix - small fix to allow new custom field renaming within the Custom Post Import plugin.
369
370 = 1.7.3 (2022-12-02) =
371 - New - add full response into the 'Test Endpoint' section.
372 - Update - readme updates and 'tested up to' update.
373 - Update - update 3 screenshots.
374
375 = 1.7.2 (2022-11-08) =
376 - New - add warning when trying to output PHP array data in shortcode.
377 - New - remove banner for Pro plugin. No one likes ads, do they?
378
379 = 1.7.1 (2022-11-02) =
380 - Enhancement - rework the 'Test Endpoint' section in admin to make it cleaner and easier to read (again).
381 - Enhancement - styling tweaks.
382
383 = 1.7.0 (2022-10-06) =
384 - Enhancement - rework the 'Test Endpoint' section in admin to make it cleaner and easier to read.
385 - Enhancement - styling tweaks.
386 - New - add banner for Pro plugin.
387
388 = 1.6.1 (2022-08-25) =
389 - Fix - modify the way the body is retrieved. Required for OAuth 2.0 Authorization plugin.
390
391 = 1.6.0 (2022-08-19) =
392 - New - add endpoint testing within the admin area.
393
394 = 1.5.4 (2022-08-15) =
395 - Fix - change response code action in version 1.5.2 to a filter.
396 - New - updated styling for admin area.
397
398 = 1.5.3 (2022-07-29) =
399 - Enhancement - add new request method PUT.
400
401 = 1.5.2 (2022-07-06) =
402 - Enhancement - add new action to get response code. Required for OAuth 2.0 Authorization plugin.
403
404 = 1.5.1 (2022-07-06) =
405 - Enhancement - add new shortcode attributes for formatting HTML in Pro plugin.
406 - Enhancement - minor styling tweaks.
407 - Fix - very minor bug fixes.
408
409 = 1.5.0 (2022-06-27) =
410 - Fix - fully internationalize the plugin.
411
412 = 1.4.10 (2022-06-22) =
413 - Fix - add new filter 'wpgetapi_json_response_body_before_decode' in place of removing invalid characters from 1.4.8 as this was stripping out non-english values.
414
415 = 1.4.9 (2022-06-22) =
416 - Enhancement - rewrite some css to make endpoint page a bit nicer and add some more screenshots.
417
418 = 1.4.8 (2022-06-07) =
419 - Enhancement - remove invalid characters from JSON data that was causing a null return.
420
421 = 1.4.7 (2022-05-25) =
422 - Fix - change the redirect after saving to a javascript solution
423
424 = 1.4.6 (2022-05-24) =
425 - Enhancement - add new attribute 'format' within shortcode that allows formatting of a number in the Pro Plugin.
426
427 = 1.4.5 (2022-05-18) =
428 - Fix - error in admin-options file.
429
430 = 1.4.4 (2022-05-18) =
431 - Enhancement - add some better, and clearer help in the admin area. Tidy up some styling.
432 - Fix - error displaying correct endpoint ID within admin area shortcode and template tag helpers. Happening when multiple endpoints added.
433
434 = 1.4.3 (2022-05-15) =
435 - Fix - body was not being set correctly.
436
437 = 1.4.2 (2022-05-13) =
438 - Enhancement - readme updates and plugin links within plugin page.
439
440 = 1.4.1 (2022-05-05) =
441 - Fix - new tab was not appearing on intitial save on setup page.
442 - Enhancement - add new filter 'wpgetapi_admin_pages' to allow adding extra tabs.
443
444 = 1.4.0 (2022-03-17) =
445 - Fix - refactor the building of request args. Body was not working correctly.
446 - Fix - change naming convention from Template Function to Template Tag within admin.
447 - Enhancement - modify output of debug to show more info and to show whether or not shortcode is used.
448
449 = 1.3.4 (2022-03-17) =
450 - Enhancement - add ability to use headers and body variables in Pro Plugin.
451
452 = 1.3.3 (2022-03-03) =
453 - Enhancement - style the debug output to make it easier to understand and provide links to docs.
454
455 = 1.3.2 (2022-02-22) =
456 - Bug fix - change paramater value fields to textarea. This allows the proper use of JSON strings within these fields.
457
458 = 1.3.1 (2022-02-16) =
459 - Bug fix - error with class property name that was not allowing proper $args to be sent to remote request
460
461 = 1.3.0 (2022-02-08) =
462 - Fix - rewrite headers parameters section
463
464 = 1.2.3 (2021-12-14) =
465 - Enhancement - add ability for query_variables to be used in shortcode with the Pro Plugin
466
467 = 1.2.2 (2021-11-09) =
468 - Enhancement - add args to debug info. Will be useful for endpoint_variables in Pro Plugin
469
470 = 1.2.1 (2021-11-05) =
471 - Bug fixes with encrypting values
472
473 = 1.2.0 (2021-11-04) =
474 - Enhancement - add option to JSON encode body parameters
475 - Enhancement - allow simple arrays to be sent in body
476
477 = 1.1.0 (2021-11-03) =
478 - Enhancement - reconfigure debug info
479 - Bug fixes
480
481 = 1.0.2 (2021-11-02) =
482 - Bug fixes
483
484 = 1.0.1 (2021-11-02) =
485 - Bug fixes
486
487 = 1.0.0 (2021-10-27) =
488 - Initial Release
489