PluginProbe
WPGet API – Connect to any external REST API / 2.1.3
WPGet API – Connect to any external REST API v2.1.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.1.3, at readme.txt

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