Web services REST API Module - Revision history

N.paul at 10:48, 1 July 2022

2022-07-01T10:48:53Z

← Older revision		Revision as of 12:48, 1 July 2022
Line 7:		Line 7:


	[[File:REST_API_1.PNG\|center]]		[[File:REST_API_1.PNG\|center\|link=]]

Admin: /* List of services */

2022-05-26T09:38:15Z

List of services

← Older revision		Revision as of 11:38, 26 May 2022
Line 16:		Line 16:

	= List of services =		= List of services =
	There are several and diverse services that are provided by Tactic. ~~The full list of Tactic provided web services can be found in the following link:~~		There are several and diverse services that are provided by Tactic.
	~~http://localhost/tactic/htdocs/societe/list.php~~		For exploring the web services the users need to paste the '''token''' of user at the top right corner. Then the users need to press the '''explore''' button for exploring through the API. However, for enjoying this facility the users first need to log-in to the API services. Upon clicking the option of '''explore''', the users need to go through all of the actions that are available. However, the available actions majorly depend on the activated modules. If the modules are not activated there will be no actions available on the API for exploring as well. The users need to use this API page very carefully as any modification in the data in the API page, directly impact the database of the software. The users will be able to test it directly from the API tool. The users will be also be able to get the results of the test as well as an example of calling the API command line using '''curl'''.
	~~The demo version of explorer can be tried at:~~
	~~http://localhost/tactic/htdocs/societe/list.php~~
	For exploring the web services the users need to paste the '''token''' of user at the top right corner. Then the users need to press the '''explore''' button for exploring through the API. However, for enjoying this facility the users first need to log-in to the API services. Upon clicking the option of '''explore''', the users need to go through all of the actions that are available. However, the available actions majorly depend on the activated modules. If the modules are not activated there will be no actions available on the API for exploring as well. The users need to use this API page very carefully as any modification in the data in the API page, directly impact the database of the software. The users will be able to test it directly from the API tool. The users will be also be able to get the results of the test as well as an example of calling the API command line using '''curl'''.
	= Usage of REST API =		= Usage of REST API =
	The usage of the API system can be utilised with the assistance of four parameter. The users can use these parameter as per their needs.		The usage of the API system can be utilised with the assistance of four parameter. The users can use these parameter as per their needs.

Admin: /* Installation */

2022-04-21T09:49:22Z

Installation

← Older revision		Revision as of 11:49, 21 April 2022
Line 2:		Line 2:
	REST API is considered as “a representational state transfer technology”, which is an architectural style of communicating within the web service development systems. This module in Tactic helps in maintaining a communication between the software and the web services. The users need to enable this module with enabling the web services and their usage provided by Tactic server. The users will then be able to make REST calls of diverse web services that is provided by Tactic.		REST API is considered as “a representational state transfer technology”, which is an architectural style of communicating within the web service development systems. This module in Tactic helps in maintaining a communication between the software and the web services. The users need to enable this module with enabling the web services and their usage provided by Tactic server. The users will then be able to make REST calls of diverse web services that is provided by Tactic.

	= ~~Installation~~ =		= Set up=
	For proceeding with the installation of '''REST API''', the users need to activate the '''REST API''' module from the setup page. After activating the Web service REST API module the users will be able to send their own request related to REST to a relative URL. The users will be able to find the list of APIs from the explorer. Any API can be selected based on the user preferences.		For proceeding with the installation of '''REST API''', the users need to activate the '''REST API''' module from the setup page. After activating the Web service REST API module the users will be able to send their own request related to REST to a relative URL. The users will be able to find the list of APIs from the explorer. Any API can be selected based on the user preferences.



			[[File:REST_API_1.PNG\|center]]


	== Apache setup ==		== Apache setup ==
	There is nothing complex about the Apache setup, if Tactic works with Apache REST API will also be working without any issues. The APIs will be served by the same virtual web server as the software.		There is nothing complex about the Apache setup, if Tactic works with Apache REST API will also be working without any issues. The APIs will be served by the same virtual web server as the software.
	== Nginx setup ==		== Nginx setup ==
	The setup of Nginx is almost similar to Apache. It will also be served with the same virtual web server as the software. However, there can be several issues that can be faced by Nginx default set up. The user can easily edit their Nginx configuration file for enhancing their user experience and for mitigating the associated issues effectively.		The setup of Nginx is almost similar to Apache. It will also be served with the same virtual web server as the software. However, there can be several issues that can be faced by Nginx default set up. The user can easily edit their Nginx configuration file for enhancing their user experience and for mitigating the associated issues effectively.

	= List of services =		= List of services =
	There are several and diverse services that are provided by Tactic. The full list of Tactic provided web services can be found in the following link:		There are several and diverse services that are provided by Tactic. The full list of Tactic provided web services can be found in the following link:

Admin: /* Introduction */

2022-02-04T06:39:59Z

Introduction

← Older revision		Revision as of 08:39, 4 February 2022
Line 1:		Line 1:
	= Introduction =		= Introduction =
	REST API is considered as “a representational state transfer technology”, which is an architectural style of communicating within the web service development systems. This module in Tactic helps in ~~marinating~~ a communication between the software and the web services. The users need to enable this module with enabling the web services and their usage provided by Tactic server. The users will then be able to make REST calls of diverse web services that is provided by Tactic.		REST API is considered as “a representational state transfer technology”, which is an architectural style of communicating within the web service development systems. This module in Tactic helps in maintaining a communication between the software and the web services. The users need to enable this module with enabling the web services and their usage provided by Tactic server. The users will then be able to make REST calls of diverse web services that is provided by Tactic.

	= Installation =		= Installation =
	For proceeding with the installation of '''REST API''', the users need to activate the '''REST API''' module from the setup page. After activating the Web service REST API module the users will be able to send their own request related to REST to a relative URL. The users will be able to find the list of APIs from the explorer. Any API can be selected based on the user preferences.		For proceeding with the installation of '''REST API''', the users need to activate the '''REST API''' module from the setup page. After activating the Web service REST API module the users will be able to send their own request related to REST to a relative URL. The users will be able to find the list of APIs from the explorer. Any API can be selected based on the user preferences.

Admin: /* Examples */

2021-12-29T06:54:20Z

Examples

← Older revision		Revision as of 08:54, 29 December 2021
Line 87:		Line 87:
	/ create an order with 2 products		/ create an order with 2 products

	// The array where there will be all the products lines of my order.		// The array where there will be all the products lines of my order.
	$newCommandeLine = [];		$newCommandeLine = [];

	// product 1		// product 1
	$ref1 = "~~my_product_ref_X203ZZ~~";		$ref1 = "my_product_ref_X9418H";
	$prix1 = 10;		$prix1 = 10;
	$qtt1 = 100;		$qtt1 = 100;
	$tva1 = 20;		$tva1 = 20;
	$fk_product1		$fk_product1
	// product 2		// product 2
	$ref2 = "~~my_product_ref_B707FD~~";		$ref2 = "my_product_ref_N2903B";
	$prix2 = 13;		$prix2 = 13;
	$qtt2 = 37;		$qtt2 = 37;
	$tva2 = 20;		$tva2 = 20;

	$newCommandeLine[] = [		$newCommandeLine[] = [
	"desc" => $ref1,		"desc" => $ref1,
	"subprice" => $prix1,		"subprice" => $prix1,
	"qty" => $qtt1,		"qty" => $qtt1,
	"tva_tx" => floatval($tva1),		"tva_tx" => floatval($tva1),
	"fk_product"=> $fk_product1		"fk_product"=> $fk_product1
	];		];

	$newCommandeLine[] = [		$newCommandeLine[] = [
Line 117:		Line 117:
	"fk_product"=> $fk_product2		"fk_product"=> $fk_product2
	];		];
			if (count($newCommandeLine) > 0) {
	if (count($newCommandeLine) > 0) {		$newCommande = [
	$newCommande = [		"socid" => $clientDoliId,
	"socid" => $clientDoliId,		"type" => "0",
	"type" => "0",		"lines" => $newCommandeLine,
	"lines" => $newCommandeLine,		"note_private" => "order created automatically with API",
	"note_private" => "order created automatically with API",		];
	];		$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));
	$newCommandeResult = CallAPI("POST", $apiKey, $apiUrl."orders", json_encode($newCommande));		$newCommandeResult = json_decode($newCommandeResult, true);
	$newCommandeResult = json_decode($newCommandeResult, true);		}
	}		// Validate an order
			$newCommandeValider = [
			"idwarehouse" => "0",
	// Validate an order		"notrigger" => "0"
	$newCommandeValider = [		];
	"idwarehouse" => "0",		$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate",
	"notrigger" => "0"		json_encode($newCommandeValider));
	];		$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);
	$newCommandeValiderResult = CallAPI("POST", $apiKey, $apiUrl."orders/".$newCommandeResult."/validate", json_encode($newCommandeValider));		// search in the database if a customer exist
	$newCommandeValiderResult = json_decode($newCommandeValiderResult, true);		$customer_name = "Acme Inc";
			$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(
			"sortfield" => "t.rowid",
	// search in the database if a customer exist		"sortorder" => "ASC",
	$customer_name = "Acme Inc";		"limit" => "1",
			"mode" => "1",
	$clientSearch = json_decode(CallAPI("GET", $apiKey, $apiUrl."thirdparties", array(		"sqlfilters" => "(t.nom:=:'".$customer_name."')"
	"sortfield" => "t.rowid",
	"sortorder" => "ASC",
	"limit" => "1",
	"mode" => "1",
	"sqlfilters" => "(t.nom:=:'".$customer_name."')"
	)		)
	), true);		), true);

	limit => 1 only 1 customer		limit => 1 only 1 customer
	mode => 1, the user is looking for a customer, not a supplier (they are thirdparties too but with a different status)		mode => 1, the user is looking for a customer, not a supplier (they are thirdparties too but with a different status)

	// customer doesn't exist. Let's create it and get it's ID		// customer doesn't exist. Let's create it and get it's ID
	$newClient = [		$newClient = [
	"name" => "customer company name",		"name" => "customer company name",
	"email" => "customer company email",		"email" => "customer company email",
	"client" => "1",		"client" => "1",
	"code_client" => "-1"		"code_client" => "-1"
	];		];
	$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));		$newClientResult = CallAPI("POST", $apiKey, $apiUrl."thirdparties", json_encode($newClient));
	$newClientResult = json_decode($newClientResult, true);		$newClientResult = json_decode($newClientResult, true);
	$clientDoliId = $newClientResult;		$clientDoliId = $newClientResult;

	client => 1, is a customer (not a supplier)		client => 1, is a customer (not a supplier)

Admin: /* Examples */

2021-12-29T06:37:45Z

Examples

← Older revision		Revision as of 08:37, 29 December 2021
Line 72:		Line 72:
	if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {		if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
	// there's been an error		// there's been an error
	echo "<pre>ERROR", var_dump($newProductResult), "</pre>";		echo
	exit;		"<pre>ERROR", var_dump($newProductResult), "</pre>";
	} else {		exit;
	// everything good		} else {
	$fk_product = $newProductResult;		// everything good
	$listProduits[$fk_product] = $ref;		$fk_product = $newProductResult;
	}		$listProduits[$fk_product] = $ref;
	}		}
			}
	In this example:		In this example:
	* The users need to check the existence of the products references in the previously created array		* The users need to check the existence of the products references in the previously created array

Admin: /* Examples */

2021-12-29T06:32:15Z

Examples

← Older revision		Revision as of 08:32, 29 December 2021
Line 72:		Line 72:
	if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {		if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
	// there's been an error		// there's been an error
	echo "<pre>ERROR", var_dump($newProductResult), "</pre>";		echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
	exit;		exit;
	} else {		} else {

Admin: /* Examples */

2021-12-29T06:24:49Z

Examples

← Older revision		Revision as of 08:24, 29 December 2021
Line 72:		Line 72:
	if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {		if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
	// there's been an error		// there's been an error
	echo "<pre>ERROR", var_dump($newProductResult), "</pre>";		echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
	exit;		exit;
	} else {		} else {
	// everything good		// everything good
	$fk_product = $newProductResult;		$fk_product = $newProductResult;
	$listProduits[$fk_product] = $ref;		$listProduits[$fk_product] = $ref;
	}		}
	}		}

Admin: /* Examples */

2021-12-29T06:18:37Z

Examples

← Older revision		Revision as of 08:18, 29 December 2021
Line 55:		Line 55:
	The users need to check if the product already exists or not before creating a product.		The users need to check if the product already exists or not before creating a product.
	// my ref		// my ref
	$ref = "my_product_ref_ X9418H";		$ref = "my_product_ref_ X9418H";
	// does it exist in my array		// does it exist in my array
	$produitKey = array_search($ref, $listProduits);		$produitKey = array_search($ref, $listProduits);
	if ($produitKey) {		if ($produitKey) {
	// yes		// yes
	$fk_product = $produitKey;		$fk_product = $produitKey;
	} else {		} else {
	// no		// no
	// Create the product		// Create the product
	$newProduct = [		$newProduct = [
	"ref" => $ref,		"ref" => $ref,
	"label" => $ref		"label" => $ref
	];		];
	$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));		$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
	$newProductResult = json_decode($newProductResult, true);		$newProductResult = json_decode($newProductResult, true);
	if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {		if (isset($newProductResult["error"]) && $newProductResult["error"]["code"] >= "300") {
	// there's been an error		// there's been an error
	echo "<pre>ERROR", var_dump($newProductResult), "</pre>";		echo "<pre>ERROR", var_dump($newProductResult), "</pre>";
	exit;		exit;
	} else {		} else {
	// everything good		// everything good
	$fk_product = $newProductResult;		$fk_product = $newProductResult;
	$listProduits[$fk_product] = $ref;		$listProduits[$fk_product] = $ref;
	}		}
	}		}
	\|}
	In this example:		In this example:
	* The users need to check the existence of the products references in the previously created array		* The users need to check the existence of the products references in the previously created array

Admin: /* Examples */

2021-12-29T06:12:51Z

Examples

← Older revision		Revision as of 08:12, 29 December 2021
Line 44:		Line 44:
	* It is important to perform a html_entity_decode as every single quote is encoded		* It is important to perform a html_entity_decode as every single quote is encoded
	* The method of replacing the products with dictionnarycountries can be used for retrieving the list of nations along with their IDs		* The method of replacing the products with dictionnarycountries can be used for retrieving the list of nations along with their IDs
	{\|		// Create a product
	~~class="wikitable"~~		$ref = "my_product_ref_X9418H";
	// Create a product		$newProduct = [
	$ref = "my_product_ref_X9418H";		"ref" => $ref,
	$newProduct = [		"label" => $ref
	"ref" => $ref,		];
	"label" => $ref		$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
	];		$newProductResult = json_decode($newProductResult, true);
	$newProductResult = CallAPI("POST", $apiKey, $apiUrl."products", json_encode($newProduct));
	$newProductResult = json_decode($newProductResult, true);

	The users need to check if the product already exists or not before creating a product.		The users need to check if the product already exists or not before creating a product.