Webservice Archives

API URL : http://domain_name/api.php

Input param :

{"id":"1","name":"John Smith","address":"New York city","country":"USA","dob":"01011985","username":"john@gmail.com","password":"warRqJXcrICXjQA4dfgsdffgnlnla"}

1	{"id":"1","name":"John Smith","address":"New York city","country":"USA","dob":"01011985","username":"john@gmail.com","password":"warRqJXcrICXjQA4dfgsdffgnlnla"}

API Call Request :

http://domain_name/api.php?action=add_user&data={"id":"1","name":"John Smith","address":"New York city","country":"USA","DOB":"01011985","username":"john@gmail.com","password":"warRqJXcrICXjQA4dfgsdffgnlnla"}

1	http://domain_name/api.php?action=add_user&data={"id":"1","name":"John Smith","address":"New York city","country":"USA","DOB":"01011985","username":"john@gmail.com","password":"warRqJXcrICXjQA4dfgsdffgnlnla"}

Successfull Output :

{
    "error": null,
    "result": {
        "status": "Sucess",
        "id": 123
    }
}

{

"error": null,

"result": {

"status": "Sucess",

"id": 123

}

Error Output :

{
    "error":{
        "msg":"User already exist in database. id = 123"
    },
    "result":{
        "status":"Failed"
    }
}

{

"error":{

"msg":"User already exist in database. id = 123"

"result":{

"status":"Failed"

}

API Script (api.php) :

<?php 
	require_once("Rest.inc.php");
	require_once("database_configuration.php");

	class API extends REST{

		public function __construct()
		{
			parent::__construct();				// Init parent contructor
		}

		/*
		 * Public method for access api.
		 * This method dynmically call the method based on the query string
		 *
		 */
		public function processApi()
		{
			$func = strtolower(trim(str_replace("/","",$_REQUEST['action'])));

			if ((int)method_exists($this,$func) > 0)
			{
				$this->$func();
			}
			else
			{
				$this->response('',404); // If the method not exist with in this class, response would be "Page not found".
			}
		}

		/* 
		 *	Insert new User into Database system
		 *  method : GET
		 *  data   : json data
		 *  Output : json data
		 */
		
		private function add_user()
		{
			// You can even make more secure your webservice by resticting user request as per request type
			/*if ($this->get_request_method() != "POST")
			{
				$arr_res = array();
				$arr_res['error']  = array("msg" => "Invalid request method");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 406);
			}*/

			$data = $this->convert_json_to_array($this->_request['data']);

			$id       = $data['id'];
			$name     = $data['name'];
			$address  = $data['address'];
			$country  = $data['country'];
			$dob      = $data['dob'];
			$username = $data['username'];
			$password = $data['password'];

			// Input validations
			if (empty($id))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "User id not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}
			
			if (empty($name))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "User Name value not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}
					
			if (empty($address))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "Address value not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}
			
			if (empty($country))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "Country value not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}
			
			if (empty($dob))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "DOB value not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}

			if (empty($username))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "'username' not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}
			
			if (empty($password))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "'password' not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}

			if (!empty($id) && !empty($name) && !empty($address) && !empty($country) && !empty($dob) && !empty($username) && !empty($password))
			{
				$query = "SELECT id FROM user WHERE username = '".$username."'";
				$result = mysql_query($query);
				if (mysql_num_rows($result)>0)
				{
					$user_data = mysql_fetch_array($result) ;                
					$user_id = $user_data["id"];
					
					$arr_res = array();
					$arr_res['error']  = array("msg" => "User already exist in database. id = ".$user_id);
					$arr_res['result'] = array('status' => "Failed");
					$this->response($this->json($arr_res), 200);
				}

				$insert_query = "INSERT INTO user (id, name, address, country, dob, username, password) values ('".$id."','".$name."','".$address."','".$country."','".$dob."','".$username."','".$password."')";
				
				mysql_query($insert_query);				
				$user_id = mysql_insert_id();

				$str_array = array('status' => "Success" ,'id' => $user_id);
				
				$arr_res = array();
				$arr_res['error']  = $error;
				$arr_res['result'] = $str_array;


				$this->response($this->json($arr_res), 200);
			}
			
			// If invalid inputs "Bad Request" status message and reason
			$error = array("msg" => "Invalid input parameter");
			
			$arr_res = array();
			$arr_res['error']  = $error;
			$arr_res['result'] = array('status' => "Failed");
			$this->response($this->json($arr_res), 400);
		}
		
		
		/* 
		 *	Delete User from database
		 *  method : POST
		 *  data   : json data
		 *  Output : json data
		 */
		
		private function delete_user()
		{
			/*if ($this->get_request_method() != "POST")
			{
				$arr_res = array();
				$arr_res['error']  = array("msg" => "Invalid request method");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 406);
			}*/

			$data = $this->convert_json_to_array($this->_request['data']);

			$id = $data['id'];

			// Input validations
			if (empty($id))
			{
				$arr_res=array();
				$arr_res['error']  = array("msg" => "User id not found");
				$arr_res['result'] = array('status' => "Failed");
				$this->response($this->json($arr_res), 400);
			}
			else
			{
				$select_query = "SELECT id FROM user WHERE id = '".$id."'";
				$result = mysql_query($select_query);
				if (mysql_num_rows($result) != 1)
				{
					$arr_res = array();
					$arr_res['error']  = array("msg" => "User not exist in database. id = ".$id);
					$arr_res['result'] = array('status' => "Failed");
					$this->response($this->json($arr_res), 200);
				}

				// Delete User from database
				$delete_query = "DELETE FROM user WHERE id = '".$vm_id."'";
				mysql_query($delete_query);
				
				$str_array = array('status' => "Success");
				
				$arr_res = array();
				$arr_res['error']  = $error;
				$arr_res['result'] = $str_array;

				$this->response($this->json($arr_res), 200);
			}
			
			// If invalid inputs "Bad Request" status message and reason
			$error = array("msg" => "Invalid input parameter");
			
			$arr_res = array();
			$arr_res['error']  = $error;
			$arr_res['result'] = array('status' => "Failed");
			$this->response($this->json($arr_res), 400);
		}
		
		/*
		 *	Decode JSON into array
		*/
		private function convert_json_to_array($json)
		{		 
			return json_decode($json,true);
		}
		
		/*
		 *	Encode array into JSON
		*/
		private function json($data)
		{
			if (is_array($data))
			{
				return json_encode($data);
			}
		}
	}
	
	// Initiate Library
	$api = new API;
	$api->processApi();
?>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

<?php

require_once("Rest.inc.php");

require_once("database_configuration.php");

class API extends REST{

public function __construct()

{

parent::__construct(); // Init parent contructor

}

* Public method for access api.

* This method dynmically call the method based on the query string

public function processApi()

{

$func = strtolower(trim(str_replace("/","",$_REQUEST['action'])));

if ((int)method_exists($this,$func) > 0)

{

$this->$func();

}

else

{

$this->response('',404); // If the method not exist with in this class, response would be "Page not found".

}

* Insert new User into Database system

* method : GET

* data : json data

* Output : json data

private function add_user()

{

// You can even make more secure your webservice by resticting user request as per request type

/*if ($this->get_request_method() != "POST")

{

$arr_res = array();

$arr_res['error'] = array("msg" => "Invalid request method");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 406);

}*/

$data = $this->convert_json_to_array($this->_request['data']);

$id = $data['id'];

$name = $data['name'];

$address = $data['address'];

$country = $data['country'];

$dob = $data['dob'];

$username = $data['username'];

$password = $data['password'];

// Input validations

if (empty($id))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "User id not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (empty($name))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "User Name value not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (empty($address))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "Address value not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (empty($country))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "Country value not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (empty($dob))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "DOB value not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (empty($username))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "'username' not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (empty($password))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "'password' not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

if (!empty($id) && !empty($name) && !empty($address) && !empty($country) && !empty($dob) && !empty($username) && !empty($password))

{

$query = "SELECT id FROM user WHERE username = '".$username."'";

$result = mysql_query($query);

if (mysql_num_rows($result)>0)

{

$user_data = mysql_fetch_array($result) ;

$user_id = $user_data["id"];

$arr_res = array();

$arr_res['error'] = array("msg" => "User already exist in database. id = ".$user_id);

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 200);

}

$insert_query = "INSERT INTO user (id, name, address, country, dob, username, password) values ('".$id."','".$name."','".$address."','".$country."','".$dob."','".$username."','".$password."')";

mysql_query($insert_query);

$user_id = mysql_insert_id();

$str_array = array('status' => "Success" ,'id' => $user_id);

$arr_res = array();

$arr_res['error'] = $error;

$arr_res['result'] = $str_array;

$this->response($this->json($arr_res), 200);

}

// If invalid inputs "Bad Request" status message and reason

$error = array("msg" => "Invalid input parameter");

$arr_res = array();

$arr_res['error'] = $error;

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

* Delete User from database

* method : POST

* data : json data

* Output : json data

private function delete_user()

{

/*if ($this->get_request_method() != "POST")

{

$arr_res = array();

$arr_res['error'] = array("msg" => "Invalid request method");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 406);

}*/

$data = $this->convert_json_to_array($this->_request['data']);

$id = $data['id'];

// Input validations

if (empty($id))

{

$arr_res=array();

$arr_res['error'] = array("msg" => "User id not found");

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

else

{

$select_query = "SELECT id FROM user WHERE id = '".$id."'";

$result = mysql_query($select_query);

if (mysql_num_rows($result) != 1)

{

$arr_res = array();

$arr_res['error'] = array("msg" => "User not exist in database. id = ".$id);

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 200);

}

// Delete User from database

$delete_query = "DELETE FROM user WHERE id = '".$vm_id."'";

mysql_query($delete_query);

$str_array = array('status' => "Success");

$arr_res = array();

$arr_res['error'] = $error;

$arr_res['result'] = $str_array;

$this->response($this->json($arr_res), 200);

}

// If invalid inputs "Bad Request" status message and reason

$error = array("msg" => "Invalid input parameter");

$arr_res = array();

$arr_res['error'] = $error;

$arr_res['result'] = array('status' => "Failed");

$this->response($this->json($arr_res), 400);

}

* Decode JSON into array

private function convert_json_to_array($json)

{

return json_decode($json,true);

}

* Encode array into JSON

private function json($data)

{

if (is_array($data))

{

return json_encode($data);

}

// Initiate Library

$api = new API;

$api->processApi();

database_configuration.php

<?php

// Mysql database
$servername = "localhost";
$username = "username";
$password = "password";
$dbname = "databasename";

// Create connection
$conn = mysql_connect($servername, $username, $password);
// Check connection
if (!$conn) {
    die("Connection failed: " . mysqli_connect_error());
}

mysql_select_db($dbname);

<?php

// Mysql database

$servername = "localhost";

$username = "username";

$password = "password";

$dbname = "databasename";

// Create connection

$conn = mysql_connect($servername, $username, $password);

// Check connection

if (!$conn) {

die("Connection failed: " . mysqli_connect_error());

}

mysql_select_db($dbname);

You can download all above demos from below link :

Download Source Code

Browse source code in github : https://github.com/sagarsdeshmukh/RESTful_Webservice_Demo

The main advantage of using NuSOAP library is it allow developers to create and consume web services based on SOAP without any SOAP related PHP extensions.
If we were not able to predict production server system configuration(Like PHP version) then using of NuSOAP based web service is better.
It’s very easy to create and test webservice using NuSOAP library.

First we created the NuSOAP server which process web service request

Note : The “<webservice_url>” is absolute path of your webservice script(nusoap_api.php).
Ex. <webservice_url> = http://www.ilovephp.net/nusoap_api.php

Download Source Code

<?php
require_once("lib/nusoap.php");

// WSDL configuration
$server = new soap_server();
$server->configureWSDL('SOAP webservice API', "<webservice_url>"); // SOAP Webservice Url ex. http://www.domain_name.com/nusoap_api.php
$server->wsdl->schemaTargetNamespace = "<webservice_url>"; // SOAP Webservice Url
// eof WSDL configuration

// Web service methode initialization
$server->register('add_user', array('json'=>'xsd:string'),array('return' => 'xsd:string'),$ns);

/**
	* Add user in database
	* @param  string    
	* @return string
*/
function add_user($json)
{
	$result = array();
	$errors = array();

	if (validate_user())
	{
		// Input params
		$data =  convert_json_to_array($json);
		
		// Webservice bussness logic here
		
		$result  = array('message' => "Record added successfully");
	}
	else
	{
		$errors[] = 'User authentication failed!';
	}
	
	$result_array = array();
	$result_array['error']  = $errors;
	$result_array['result'] = $result;
	
	return json_encode($result_array);
}

/**
	* User request validation
*/
function validate_user()
{
	if($_SERVER['PHP_AUTH_USER'] == "WS_USERNAME" && $_SERVER['PHP_AUTH_PW'] == "WS_PASSWORD")  // Web service username and password validation
	{
		return true;
	}
	else
	{
		return false;
	}
}

/**
	* Convert json to array 
*/
function convert_json_to_array($json)
{		 
	return json_decode($json,true);
} 

if (!isset($HTTP_RAW_POST_DATA))
	$HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );
	
$server->service($HTTP_RAW_POST_DATA);
?>

<?php

require_once("lib/nusoap.php");

// WSDL configuration

$server = new soap_server();

$server->configureWSDL('SOAP webservice API', "<webservice_url>"); // SOAP Webservice Url ex. http://www.domain_name.com/nusoap_api.php

$server->wsdl->schemaTargetNamespace = "<webservice_url>"; // SOAP Webservice Url

// eof WSDL configuration

// Web service methode initialization

$server->register('add_user', array('json'=>'xsd:string'),array('return' => 'xsd:string'),$ns);

/**

* Add user in database

* @param string

* @return string

function add_user($json)

{

$result = array();

$errors = array();

if (validate_user())

{

// Input params

$data = convert_json_to_array($json);

// Webservice bussness logic here

$result = array('message' => "Record added successfully");

}

else

{

$errors[] = 'User authentication failed!';

}

$result_array = array();

$result_array['error'] = $errors;

$result_array['result'] = $result;

return json_encode($result_array);

}

/**

* User request validation

function validate_user()

{

if($_SERVER['PHP_AUTH_USER'] == "WS_USERNAME" && $_SERVER['PHP_AUTH_PW'] == "WS_PASSWORD") // Web service username and password validation

{

return true;

}

else

{

return false;

}

/**

* Convert json to array

function convert_json_to_array($json)

{

return json_decode($json,true);

}

if (!isset($HTTP_RAW_POST_DATA))

$HTTP_RAW_POST_DATA = file_get_contents( 'php://input' );

$server->service($HTTP_RAW_POST_DATA);

To consume and test above webservice we use below webservice client script.

<?php
	require_once('lib/nusoap.php');

	$wsdl   = "<webservice_url>?wsdl"; // SOAP Webservice Url ex. http://www.domain_name.com/nusoap_api.php?wsdl

	$client = new nusoap_client($wsdl, 'wsdl');
	
	// Input params
	if (isset($_POST['submit']))
	{
		$username = $_POST['username'];
		$password = $_POST['password'];
		$json 	  = $_POST['json'];
	}
	else
	{
		$username = "WS_USERNAME";
		$password = "WS_PASSWORD";
		$json	  = '{"name":"Ajay","dept":"sales","address":"Nashik","birthdate":"24/04/1991"}';
	}
	// EOF Input params
	
	$client->setCredentials($username, $password);  // Webservice credential
    $error = $client->getError();
	
	if ($error)
	{
		echo $error; die();
	}
	
	$action = "add_user"; // Webservice methode name
	
	$result = array();

	if (isset($action))
	{
		$data["json"] = $json;
		$result['response'] = $client->call($action, $data);
	}
	
	// Display webservice details
	echo "<h1>SOAP Web Service Client</h1>";
	echo "<h3>Web service URL : ".str_replace("?wsdl","",$wsdl)."</h3>";
	echo "<h3>Operation Name : </h3>".$action;
	echo "<form action=\"\" method=\"post\" >";
	echo "<h3>Webservice Credentials : </h3>";
	echo "Username : ";
	echo "<input type=\"text\" style=\"width:200px;\" name=\"username\" value=\"WS_USERNAME\">";
	echo "<br>";
	echo "Password : ";
	echo "<input type=\"text\" style=\"width:200px;\" name=\"password\" value=\"WS_PASSWORD\">";
	
	echo "<h3>Input Parameter : </h3>";
	echo "<table> <tr><td>json = </td><td><textarea name=\"json\" rows='6' cols='100'>".$json."</textarea></td></tr></table>";
	
	echo "<input type=\"submit\" name=\"submit\" value=\"Invoke\">";
	echo "<br>";
	echo "<h3>Output : </h3>";
	echo $result['response'];
	echo "<br><br>";
	echo "<form>";
	echo "-------------------------------------------------------------------------";
	echo "-------------------------------------------------------------------------";
	echo "<h2>Request</h2>";
	echo "<pre>" . htmlspecialchars($client->request, ENT_QUOTES) . "</pre>";
	echo "<h2>Response</h2>";
	echo "<pre>" . htmlspecialchars($client->response, ENT_QUOTES) . "</pre>";
?>

<?php

require_once('lib/nusoap.php');

$wsdl = "<webservice_url>?wsdl"; // SOAP Webservice Url ex. http://www.domain_name.com/nusoap_api.php?wsdl

$client = new nusoap_client($wsdl, 'wsdl');

// Input params

if (isset($_POST['submit']))

{

$username = $_POST['username'];

$password = $_POST['password'];

$json = $_POST['json'];

}

else

{

$username = "WS_USERNAME";

$password = "WS_PASSWORD";

$json = '{"name":"Ajay","dept":"sales","address":"Nashik","birthdate":"24/04/1991"}';

}

// EOF Input params

$client->setCredentials($username, $password); // Webservice credential

$error = $client->getError();

if ($error)

{

echo $error; die();

}

$action = "add_user"; // Webservice methode name

$result = array();

if (isset($action))

{

$data["json"] = $json;

$result['response'] = $client->call($action, $data);

}

// Display webservice details

echo "<h1>SOAP Web Service Client</h1>";

echo "<h3>Web service URL : ".str_replace("?wsdl","",$wsdl)."</h3>";

echo "<h3>Operation Name : </h3>".$action;

echo "<form action=\"\" method=\"post\" >";

echo "<h3>Webservice Credentials : </h3>";

echo "Username : ";

echo "<input type=\"text\" style=\"width:200px;\" name=\"username\" value=\"WS_USERNAME\">";

echo "<br>";

echo "Password : ";

echo "<input type=\"text\" style=\"width:200px;\" name=\"password\" value=\"WS_PASSWORD\">";

echo "<h3>Input Parameter : </h3>";

echo "<table> <tr><td>json = </td><td><textarea name=\"json\" rows='6' cols='100'>".$json."</textarea></td></tr></table>";

echo "<input type=\"submit\" name=\"submit\" value=\"Invoke\">";

echo "<br>";

echo "<h3>Output : </h3>";

echo $result['response'];

echo "<br><br>";

echo "<form>";

echo "-------------------------------------------------------------------------";

echo "<h2>Request</h2>";

echo "<pre>" . htmlspecialchars($client->request, ENT_QUOTES) . "</pre>";

echo "<h2>Response</h2>";

echo "<pre>" . htmlspecialchars($client->response, ENT_QUOTES) . "</pre>";

Download Source Code

That’s it about NuSOAP webservice.
Happy Coding 🙂

ILovePHP

Open knowledge sharing platform for php lovers

Tag: Webservice

Simple RESTful API webservice demo in PHP

SOAP Web Service Demo using NuSOAP library