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