1. Use cases for Custom REST API Plugin [Enterprise] version

Directly Fetch Data From The REST API Endpoint To Display On WordPress Site

• Imagine you have a REST API endpoint granted by your API provider and want to retrieve data from their side. This process can be effortlessly executed within seconds by employing our plugin's External APIs integration feature, directly into the WordPress backend, enabling an effective WordPress API integration. The retrieved data can then be seamlessly employed for showcasing purposes on your WordPress site.
  
  Additionally, you can share real-time data through API endpoint requests. For instances where an External API call is necessary, the plugin offers a dedicated WordPress hook that can be conveniently utilized.

Call External (Non-WordPress) REST API For Form Submission Events

• Suppose you have a WordPress site integrated with an External/Third-party provider. You now want to:

  1. Perform some actions like register/sign in/delete members on the third-party provider side .

  2. Fetch/update some other data by making the REST APIs call to the provider based on events like WPforms, Gravity Forms, Elementor, Contact-form7, or any other form submission.

  Our plugin provides WordPress API integration using a hook specific to external External/Third-party API connections. This hook can be easily integrated dynamically with all the forms, run on the submission, and provide the status of the API call.

Integrate External REST APIs On Payment Gateways

• Let's say your WordPress website includes a payment gateway, such as PayPal, Stripe, or any other that is offered by Woocommerce, Wpforms, the Stripe plugin, or any other plugin.
  You want to call specific APIs to update the user status, membership level, etc. on the third-party API provider based on the payment status and amount. This is easily accomplished by using the hook provided by our plugin to call external API from WordPress. This hook can be embedded directly into the gateways and run only based on the transaction status.

Sync/Fetch Data From The Supplier’s External API Into Woocommerce

• Suppose you have external APIs provided by your supplier (distributor) and want to sync the real-time data fetched from these external APIs into Woocommerce to display these data/products.
  Our plugin provides you with the ability to use external API in WordPress site. These APIs can be called in the backend using the developer hooks to sync the real-time data with woocommerce products/items feeds and can be displayed on your site.


• Click here to know more about WooCommerce Product Sync via APIs.

Note: Our plugin provides WordPress API integration using a hook specific to external External/Third-party API connections. This hook can be easily integrated dynamically with all the forms, run on the submission, and provide the status of the API call.In case you are also looking to integrate these developer hooks on the backend according to your requirements, please contact apisupport@xecurify.com to know more and let us know your complete requirements.

2. Steps to configure Custom REST API Endpoint requests with different

3. Generate Custom REST API endpoints using custom SQL in WordPress

• To use this feature go to ‘Create Custom SQL API tab’ in the plugin.

• For GET Method:

  Sample SQL query → Select * from custom_table NATURAL JOIN custom_table2 where ID="{{custom_param1}}";
  
  Sample API request format → 
  <Your domain>/wp-json/mo/v1/<api name>?custom_param1=2
  
                    

• For POST Method:

  Sample SQL query → INSERT INTO custom_table (ID, name, email, status) VALUES ('{{custom_param1}}','{{custom_param2}}','{{custom_param3}}','{{custom_param4}}');
  
  Sample API request format → curl -d "custom_param1=2&custom_param2=testuser&custom_param3=testuser@gmail.com&custom_param4=1” -X POST <Your domain>/wp-json/mo/v1/<api name>
  
                    

• For PUT Method:

  Sample SQL query→ UPDATE custom_table SET 
  ID='{{custom_param1}}',name='{{custom_param2}}',email='{{custom_param3}}',status='{{custom_param4}}' WHERE ID={{custom_param5}};
  
  
  Sample API request format → curl -d "custom_param1=2&custom_param2=testuser&custom_param3=testuser@yahoo.com&custom_param4=1&custom_param5=2" -X PUT <Your domain>/wp-json/mo/v1/<api name>
                    

• For DELETE Method:

  Sample SQL query→ DELETE FROM custom_table WHERE ID={{custom_param1}};
  
  Sample API request format → curl -d "custom_param1=0" -X DELETE<Your domain>/wp-json/mo/v1/<api name>
  
                    

Note 1:Please pass the arguments as per the sequence/order as mentioned in the above sample SQL query and sample API request examples.

Note 2:The custom attribute passed in the query should be in the following format “custom_param<i>” where i is the integer value that starts from 1 and increases as the number of custom parameters increases in the SQL query and also should be passed in the incremental sequence as shown in the above examples.