CheckView

Branch description

main:- This branch corresponds to the latest version in svn repository for CheckView. To release a new version to svn repo, always make sure you merge your final changes into the main branch and test it thoroughly. After testing make sure you have checked out in main branch. Must use following command if not on main branch:
git checkout main
git pull origin main
Now you have latest code in your local main branch.
Then you have to create a new tag that should resemble the latest version of the plugin.
If we want to release 1.1.20 let's say here how we will do it. Use following commands on your main branch locally.
git tag -a v1.0.20 -m "Release version 1.0.20" ( make sure to use this syntax v1.0.20 anything after v will be released as a new version )
This will create a new tag with above comment. After this you have to push your newly created tag.
git push origin v1.0.20 ( again is used same syntax )
That's it it will create a new tag and release in github and will push to the svn repo. You don't have to create any release or tag directly in Github.

trunk:- This branch holds latest version for trunk folder of svn repository for CheckView.
This branch should only be used if you don't want to release a new version and just want to update readme's or descriptions or assets in current version.
To work with this branch in really simple.
git pull origin trunk
git add .
git commit -m "added your changes"
git push
That's it. It will push your changes to the trunk folder of svn repo and also the version that's currently active.

Development process

Setting up repository/project on local-

clone the repository on local machine
Its ready to use now.

Now you can access the project as a WP plugin via browser and it should work.

Initiating new task-

whenever, the developer needs to implement new task, he should create a new branch from “master” on his/her local setup.
then developer can do and commit the changes in the newly created branch
non composer work should be done in app folder only and only changes of app folder should be commited

For composer work, for example , extension installation via composer

run composer commands on local and only commit composer.json, composer.lock and auth.json

Deploy changes to staging website -

Merge the local branch on which custom work is done with the local staging branch
then local staging branch needs to be pushed to remote staging branch
once this is done, login to staging server via SSH and navigate to root directory of WordPress
execute command git pull origin staging this will ask a password and the password is same as of SSH password
if you have pushed composer related changes then run command composer install

Deploy changes to live website -

Merge the local branch on which custom work is done with the local master branch and push the master branch to remote master branch
then merge local master branch with local production branch and push the production branch to remote production branch
once this is done, login to live server via SSH and navigate to root directory of WordPress
execute command git pull origin production this will ask a password and the password is same as of SSH password
if you have pushed composer related changes then run command composer install

# CheckView API Class

Handles Froms API functions for the CheckView plugin.

## Table of Contents

- [Overview](#overview)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Endpoints](#endpoints)
- [Methods](#methods)
- [Permission Check](#permission-check)

## Overview

This class defines the code necessary for handling CheckView Form API CRUD operations. It includes methods for registering REST API routes, retrieving available forms, registering form tests, managing test results, cart details, payment gateways, customer creation, and store locations.

## Requirements

- PHP 5.6 or later
- WordPress
- CheckView plugin

## Installation

Include this class in your plugin or theme:

```php
require_once 'path/to/class-checkview-api.php';

Usage

Initialize the class:

$checkview_api = new CheckView_Api( 'your_plugin_name', 'your_plugin_version' );

$checkview_api->checkview_register_rest_route();

Base URL

The base URL for the API is https://your-wordpress-site.com/wp-json/checkview/v1.

Authentication

The API requires authentication using a valid JWT token. Include the JWT token in the request headers with the key _checkview_token.

Endpoints

1. Retrieve Available Forms List

Endpoint: /forms/formslist (GET)
Description: Retrieve the list of available forms.
Parameters:
- _checkview_token (not required): Valid JWT token for authentication.
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Usage:

GET /wp-json/checkview/v1/forms/formslist?_checkview_token=your_jwt_token

Returns:
- 200 OK on success with JSON body containing the forms list.
- 400 Bad Request on failure with error details.

Response:

{
  "status": 200,
  "response": "Successfully retrieved the forms list.",
  "body_response": {
    "GravityForms": {
      "1": {
        "ID": 1,
        "Name": "Gravity Form 1",
        "addons": ["addon1", "addon2"],
        "pages": [{"ID": 1, "url": "https://example.com/page1"}]
      },
      "2": {
        "ID": 2,
        "Name": "Gravity Form 2",
        "addons": ["addon3", "addon4"],
        "pages": [{"ID": 2, "url": "https://example.com/page2"}]
      }
    },
    "FluentForms": {
      "3": {"ID": 3, "Name": "Fluent Form 1", "pages": [{"ID": 3, "url": "https://example.com/page3"}]}
    },
    // ... other form types
  }
}

2. Register Form Test

Endpoint: /forms/registerformtest (PUT)
Description: Register a form test for validation.
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): Valid JWT token for authentication.
- frm_id (required): Form ID.
- pg_id (required): Page ID.
- type (required): Test type.
- send_to (required): Email or destination for test results.

Usage:

PUT /wp-json/checkview/v1/forms/registerformtest?_checkview_token=your_jwt_token&frm_id=123&pg_id=456&type=test&[email protected]

Returns:
- 200 OK on success with JSON body containing success message.
- 400 Bad Request on failure with error details.

Response:

{
  "status": 200,
  "response": "success",
  "body_response": "Check Form Test Successfully Added"
}

3. Retrieve Test Results for a Form

Endpoint: /forms/formstestresults (GET)
Description: Retrieve test results for a specific form.
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- uid (required): User ID.
- _checkview_token (not required): Valid JWT token for authentication.

Usage:

GET /wp-json/checkview/v1/forms/formstestresults?uid=123&_checkview_token=your_jwt_token

Returns:
- 200 OK on success with JSON body containing the test results.
- 400 Bad Request on failure with error details.

Response:

{
  "status": 200,
  "response": "Successfully retrieved the test results.",
  "body_response": [
    {"field_id": "input_1_field1", "field_value": "Value1"},
    {"field_id": "input_1_field2", "field_value": "Value2"},
    // ... other fields
  ]
}

4. Delete Test Results for a Form

Endpoint: /forms/deleteformstest (DELETE)
Description: Delete test results for a specific form.
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- uid (required): User ID.
- _checkview_token (not required): Valid JWT token for authentication.

Usage:

DELETE /wp-json/checkview/v1/forms/deleteformstest?uid=123&_checkview_token=your_jwt_token

Returns:
- 200 OK on success with JSON body containing success message.
- 400 Bad Request on failure with error details.

Methods

checkview_get_available_forms_list() - Retrieve available forms list.
checkview_get_available_forms_test_results() - Retrieve test results for a form.
checkview_register_form_test() - Register a form test.
checkview_delete_forms_test_results() - Delete test results for a form.

Permission Check

The class includes a permission check for validating JWT tokens before API calls. The get_items_permissions_check() method performs the check.

// Example Usage
$valid_token = $checkview_api->get_items_permissions_check( $request );
if ( is_wp_error( $valid_token ) ) {
    // Handle invalid token.
} else {
    // Proceed with the API call.
}

Certainly! Here is the documentation in README.md format:

Overview

The Checkview API provides endpoints to retrieve information about orders, products, shipping details, and to delete orders. It requires a valid JWT token for authentication. You will have to provide these two params in url checkview_use_stripe & checkview_test_id. If checkview_use_stripe param is set it will turn stripe test mod on otherwise checkview custom payment gateway will be visible.

Endpoints

1. Get Available Orders

Endpoint

GET /checkview/v1/store/orders

Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Parameters

_checkview_token (not required): JWT token for authentication.
checkview_order_last_modified_since (optional): Retrieve orders modified since this date.
checkview_order_last_modified_until (optional): Retrieve orders modified until this date.
checkview_order_id_after (optional): Retrieve orders with IDs greater than this value.
checkview_order_id_before (optional): Retrieve orders with IDs less than this value.

Usage

curl -X GET "https://your-api-domain.com/checkview/v1/store/orders?_checkview_token=your-jwt-token"

Returns

Status 200: Successfully retrieved the orders.

{
  "status": 200,
  "response": "Successfully retrieved the orders.",
  "body_response": [orders_data]
}

Status 200: No orders to show.

{
  "status": 200,
  "response": "No orders to show.",
  "body_response": []
}

2. Get Available Products

Endpoint

GET /checkview/v1/store/products

Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Parameters

_checkview_token (not required): JWT token for authentication.
checkview_keyword (optional): Keyword to search for products.
checkview_product_type (optional): Product type to filter results.

Usage

curl -X GET "https://your-api-domain.com/checkview/v1/store/products?_checkview_token=your-jwt-token"

Returns

Status 200: Successfully retrieved the products.

{
  "status": 200,
  "response": "Successfully retrieved the products.",
  "body_response": [products_data]
}

Status 200: No products to show.

{
  "status": 200,
  "response": "No products to show.",
  "body_response": []
}

3. Get Available Shipping Details

Endpoint

GET /checkview/v1/store/shippingdetails

Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Parameters

_checkview_token (not required): JWT token for authentication.

Usage

curl -X GET "https://your-api-domain.com/checkview/v1/store/shippingdetails?_checkview_token=your-jwt-token"

Returns

Status 200: Successfully retrieved the shipping details.

{
  "status": 200,
  "response": "Successfully retrieved the shipping details.",
  "body_response": [shipping_details_data]
}

Status 200: No shipping details to show.

{
  "status": 200,
  "response": "No shipping details to show.",
  "body_response": []
}

4. Delete Orders

Endpoint

DELETE /checkview/v1/store/deleteorders

Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Parameters

_checkview_token (not required): JWT token for authentication.

Usage

curl -X DELETE "https://your-api-domain.com/checkview/v1/store/deleteorders?_checkview_token=your-jwt-token"

Returns

Status 200: Successfully removed the results.

{
  "status": 200,
  "response": "Successfully removed the results."
}

Status 400: Failed to remove the results.

{
  "status": 400,
  "response": "Failed to remove the results."
}

5. `checkview_get_available_shipping_details`

Get shipping details and related data.

Endpoint: /checkview/v1/store/shippingdetails
HTTP Method: GET
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.

Usage:

curl -X GET "https://your-wordpress-site.com/checkview/v1/store/shippingdetails?_checkview_token=your-jwt-token"

Returns:
- Status 200: Successfully retrieved the shipping details.
- Status 400: Failed to retrieve shipping details.

6. `checkview_get_cart_details`

Lists cart details.

Endpoint: /checkview/v1/store/cartdetails
HTTP Method: GET
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.
- cookie (required): cookies from the browser.

Usage:

curl -X GET "https://your-wordpress-site.com/checkview/v1/store/cartdetails?_checkview_token=your-jwt-token"

Returns:

Status 200: Successfully retrieved the cart details.
Status 400: Failed to retrieve cart details.

{
  "status": 200,
  "response": "Successfully retrieved active payment gateways.",
    "body_response": {
      "items":[{"key":"b6d767d2f8ed5d21a44b0e5886680cb9", "id":22,"type":"simple","quantity":2,"quantity_limits":{"minimum":1,"maximum":9999,"multiple_of":1,"editable":true},"name":"awesome","short_description":"","description":"<p>jhhjhjjh<\/p>","sku":"awesome","low_stock_remaining":null,"backorders_allowed":false,"show_backorder_badge":false,"sold_individually":false,"permalink":"http:\/\/inspry-test-site.local\/product\/awesome\/","images":[],"variation":[],"item_data":[],"prices":{"price":"100","regular_price":"900000","sale_price":"100","price_range":null,"currency_code":"EUR","currency_symbol":"\u20ac","currency_minor_unit":2,"currency_decimal_separator":",","currency_thousand_separator":"","currency_prefix":"","currency_suffix":" \u20ac","raw_prices":{"precision":6,"price":"1000000","regular_price":"9000000000","sale_price":"1000000"}},"totals":{"line_subtotal":"200","line_subtotal_tax":"0","line_total":"200","line_total_tax":"0","currency_code":"EUR","currency_symbol":"\u20ac","currency_minor_unit":2,"currency_decimal_separator":",","currency_thousand_separator":"","currency_prefix":"","currency_suffix":" \u20ac"},"catalog_visibility":"visible","extensions":{}}],"coupons":[],"fees":[],"totals":{"total_items":"200","total_items_tax":"0","total_fees":"0","total_fees_tax":"0","total_discount":"0","total_discount_tax":"0","total_shipping":"0","total_shipping_tax":"0","total_price":"200","total_tax":"0","tax_lines":[],"currency_code":"EUR","currency_symbol":"\u20ac","currency_minor_unit":2,"currency_decimal_separator":",","currency_thousand_separator":"","currency_prefix":"","currency_suffix":" \u20ac"},"shipping_address":{"first_name":"Faizan","last_name":"g","company":"","address_1":"R silva","address_2":"","city":"MAIA","state":"","postcode":"4457-451","country":"PT","phone":""},"billing_address":{"first_name":"Faizan","last_name":"g","company":"","address_1":"R silva","address_2":"","city":"MAIA","state":"","postcode":"4457-451","country":"PT","email":"[email protected]","phone":""},"needs_payment":true,"needs_shipping":true,"payment_requirements":["products"],"has_calculated_shipping":true,"shipping_rates":[{"package_id":0,"name":"Shipment 1","destination":{"address_1":"R silva","address_2":"","city":"MAIA","state":"","postcode":"4457-451","country":"PT"},"items":[{"key":"b6d767d2f8ed5d21a44b0e5886680cb9","name":"awesome","quantity":2}],"shipping_rates":[{"rate_id":"free_shipping:1","name":"Free shipping","description":"","delivery_time":"","price":"0","taxes":"0","instance_id":1,"method_id":"free_shipping","meta_data":[{"key":"Items","value":"awesome &times; 2"}],"selected":true,"currency_code":"EUR","currency_symbol":"\u20ac","currency_minor_unit":2,"currency_decimal_separator":",","currency_thousand_separator":"","currency_prefix":"","currency_suffix":" \u20ac"}]}],"items_count":2,"items_weight":0,"cross_sells":[],"errors":[],"payment_methods":["cod","checkview"],"extensions":{}}
}

7. `checkview_get_active_payment_gateways`

Lists active payment gateways.

Endpoint: /checkview/v1/store/activegateways
HTTP Method: PUT, GET
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.

Usage:

curl -X PUT "https://your-wordpress-site.com/checkview/v1/store/activegateways?_checkview_token=your-jwt-token"

Returns:
- Status 200: Successfully retrieved active payment gateways.
- Status 400: Failed to retrieve active payment gateways.

  {
    "status": 200,
    "response": "Successfully retrieved active payment gateways.",
    "body_response": {
                    "stripe": "Stripe",
                  }
  }

8. `checkview_create_test_customer`

Creates a test customer.

Endpoint: /checkview/v1/store/createtestcustomer
HTTP Method: POST
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.

Usage:

curl -X POST "https://your-wordpress-site.com/checkview/v1/store/createtestcustomer?_checkview_token=your-jwt-token"

Returns:
- Status 200: Successfully created the test customer.
- Status 400: Failed to create the test customer.

9. `checkview_get_test_customer_credentials`

Retrieves test customer credentials.

Endpoint: /checkview/v1/store/gettestcustomer
HTTP Method: GET
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.

Usage:

curl -X GET "https://your-wordpress-site.com/checkview/v1/store/gettestcustomer?_checkview_token=your-jwt-token"

Returns:
- Status 200: Successfully retrieved test customer credentials.
- Status 400: Failed to retrieve test customer credentials.

  {
    "status": 200,
    "response": "Successfully retrieved test customer credentials.",
    "body_response": {
                    "email": "[email protected]",
                    "username": "customer_username",
                    "password": "customer_password"
                  }
  }

10. `checkview_get_store_locations`

Retrieves store locations.

Endpoint: /checkview/v1/store/getstorelocations
HTTP Method: GET
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.

Usage:

curl -X GET "https://your-wordpress-site.com/checkview/v1/store/getstorelocations?_checkview_token=your-jwt-token"

Returns:
- Status 200: Successfully retrieved store locations.
- Status 400: Failed to retrieve store locations.

  {"status":200,"response":"Successfully retrieved the store locations.","body":{"selling_locations":{"AL":"Albania","AS":"American Samoa"},"shipping_locations":{"AL":"Albania","AS":"American Samoa"}}}

11. `saas_get_site_info`

Retrieves a list of all installed plugins, themes, and the WordPress core version.

Endpoint: /checkview/v1/site-info
HTTP Method: GET
Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.
Parameters:
- _checkview_token (not required): JWT token for authentication.

Usage:

curl -X GET "https://your-wordpress-site.com/wp-json/checkview/v1/site-info?_checkview_token=your-jwt-token"

Returns:
- Status 200: Successfully retrieved the site information.
- Status 403: Invalid or missing authentication token.
- Status 400: Failed to retrieve site information.

{
  "status": 200,
  "response": "Successfully retrieved site information.",
  "body": {
    "plugins": [
      {
        "name": "Plugin Name",
        "version": "1.0.0",
        "plugin_file": "plugin-directory/plugin-file.php",
        "active": true
      }
    ],
    "themes": [
      {
        "name": "Theme Name",
        "version": "1.2.3",
        "stylesheet": "theme-directory",
        "active": true
      }
    ],
    "core": {
      "version": "6.0.1"
    }
  }
}

Example Response

{
  "plugins": [
    {
      "name": "Akismet Anti-Spam",
      "version": "4.2.2",
      "plugin_file": "akismet/akismet.php",
      "active": true
    },
    {
      "name": "Hello Dolly",
      "version": "1.7.2",
      "plugin_file": "hello-dolly/hello.php",
      "active": false
    }
  ],
  "themes": [
    {
      "name": "Twenty Twenty-One",
      "version": "1.7",
      "stylesheet": "twentytwentyone",
      "active": false
    },
    {
      "name": "Twenty Twenty-Three",
      "version": "1.0",
      "stylesheet": "twentytwentythree",
      "active": true
    }
  ],
  "core": {
    "version": "6.3"
  }
}

Notes:
- The _checkview_token parameter is required in headers and must be a valid JWT token. If the token is missing or invalid, the request will return a 403 Forbidden status.
- The "active" field in the plugins and themes list indicates whether the plugin or theme is currently active.
- The "version" field in the plugins and themes list indicates the version of the plugin or theme.

Below is the updated documentation reflecting the added authentication using the _checkview_token in header.

Validate Token

Endpoint

GET /checkview/v1/validate/token

Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Parameters

_checkview_token (optional): JWT token for validation.

Usage

curl -X GET "https://your-api-domain.com/checkview/v1/validate/token?_checkview_token=your-jwt-token"

Returns

Status 200: Valid token.

{
  "code": "jwt_auth_valid_token",
  "data": {
    "status": 200
  }
}

Status 400: Invalid token.

{
  "code": "jwt_auth_invalid_token",
  "data": {
    "status": 400
  }
}

Permissions Check

Checkview Get Items Permissions Check

Endpoint

GET /checkview/v1/permissions/check

Headers:
- _checkview_token (required): Valid JWT token bearer for authentication.

Parameters

_checkview_token (optional): JWT token for validation.

Usage

curl -X GET "https://your-api-domain.com/checkview/v1/permissions/check?_checkview_token=your-jwt-token"

Returns

Status 200: Valid token.

{
  "code": "jwt_auth_valid_token",
  "data": {
    "status": 200
  }
}

Status 400: Invalid token.

{
  "code": "jwt_auth_invalid_token",
  "data": {
    "status": 400
  }
}

To build the WooCommerce payment gateway block.

nvm use
npm install
npm run packages-update
npm run build

Notes

JWT authentication is required for all endpoints.
A unique nonce must be included in all requests.
Results are cached for 12 hours to improve performance.

Notes

The API responses and examples provided are for illustrative purposes. Make sure to replace placeholder values such as Your_JWT_Token, form IDs, page IDs, etc., with actual values.
This documentation assumes the implementation of the JWT authentication mechanism and the functions checkview_validate_jwt_token and checkview_must_ssl_url, which are referenced in the provided code. Ensure that these functions are defined and functional in your implementation.
Adjust the URLs, namespaces, and authentication mechanisms based on your WordPress setup and customizations.

For more information, visit CheckView Documentation.

checkview

CheckView

Branch description

Development process

Setting up repository/project on local-

Initiating new task-

Deploy changes to staging website -

Deploy changes to live website -

Usage

Base URL

Authentication

Endpoints

1. Retrieve Available Forms List

2. Register Form Test

3. Retrieve Test Results for a Form

4. Delete Test Results for a Form

Methods

Permission Check

Overview

Endpoints

1. Get Available Orders

Endpoint

Parameters

Usage

Returns

2. Get Available Products

Endpoint

Parameters

Usage

Returns

3. Get Available Shipping Details

Endpoint

Parameters

Usage

Returns

4. Delete Orders

Endpoint

Parameters

Usage

Returns

5. checkview_get_available_shipping_details

6. checkview_get_cart_details

7. checkview_get_active_payment_gateways

8. checkview_create_test_customer

9. checkview_get_test_customer_credentials

10. checkview_get_store_locations

11. saas_get_site_info

Example Response

Validate Token

Endpoint

Parameters

Usage

Returns

Permissions Check

Checkview Get Items Permissions Check

Endpoint

Parameters

Usage

Returns

To build the WooCommerce payment gateway block.

Notes

Notes

5. `checkview_get_available_shipping_details`

6. `checkview_get_cart_details`

7. `checkview_get_active_payment_gateways`

8. `checkview_create_test_customer`

9. `checkview_get_test_customer_credentials`

10. `checkview_get_store_locations`

11. `saas_get_site_info`