How to Create a REST API in Codeigniter with Basic Authentication



A REST API is a web service which uses HTTP methods likes GET, PUT, POST, DELETE for data manipulation over the cross platforms. We will build a PHP Rest Api Using codeignitor.

Question- What is API?

Answer - API Stands for Application Programming interface (to know more about Click here ) 

Question - What is REST in REST API?

Answer - REST stands for Representational State Transfer. 

You can download the codeignitor from here - https://codeigniter.com/download


Create Database and Table(s)

I will now create a simple database with a table named User. In order to create the database, go to the Application Management tab and launch the database manager.

Type in the following command in the SQL command field:





  1. CREATE TABLE `tbl_user` (  
  2.  `user_id` int(11) NOT NULL,  
  3.  `user_name` varchar(40) NOT NULL,  
  4.  `user_password` varchar(40) NOT NULL,  
  5.  `user_type` varchar(15) NOT NULL  
  6. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;  



Setting up Libraries and Permissions



A REST API is a web service which uses HTTP methods likes GET, PUT, POST, DELETE for data manipulation over the cross platforms. We will build a PHP Rest Api Using codeignitor.

Question- What is API?

Answer - API Stands for Application Programming interface (to know more about Click here ) 

Question - What is REST in REST API?

Answer - REST stands for Representational State Transfer. 

You can download the codeignitor from here - https://codeigniter.com/download


Create Database and Table(s)

I will now create a simple database with a table named User. In order to create the database, go to the Application Management tab and launch the database manager.

Type in the following command in the SQL command field:





  1. CREATE TABLE `tbl_user` (  
  2.  `user_id` int(11) NOT NULL,  
  3.  `user_name` varchar(40) NOT NULL,  
  4.  `user_password` varchar(40) NOT NULL,  
  5.  `user_type` varchar(15) NOT NULL  
  6. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;  



Setting up Libraries and Permissions


First of all, download codeigniter-restserver and codeigniter-restclient libraries. Extract the contents and then drag and drop application/libraries/Format.php and application/libraries/REST_Controller.php files into the application’s directories.Remember to add require_once it at the top of the controllers in order to load them into the scope. Additionally, copy rest.php file from application/config in application’s configuration directory.

You might be interested in: How To Pass Data From Controller To View In CodeIgniter

Now create a file in the application’s root folder and name it. Paste the following code in it.

Setup Authentication and API Key

First of all, download codeigniter-restserver and codeigniter-restclient libraries. Extract the contents and then drag and drop application/libraries/Format.php and application/libraries/REST_Controller.php files into the application’s directories.Remember to add require_once it at the top of the controllers in order to load them into the scope. Additionally, copy rest.php file from application/config in application’s configuration directory.

You might be interested in: How To Pass Data From Controller To View In CodeIgniter

Now create a file in the application’s root folder and name it .htaccess. Paste the following code in it.

  1. RewriteEngine On
  3. RewriteCond %{REQUEST_FILENAME} !-f
  5. RewriteCond %{REQUEST_FILENAME} !-d
  7. RewriteRule ^(.*)$ index.php/$1 [L]

Setup Authentication and API Key

To setup authentication, first create the following tables in the database:

 

  1. CREATE TABLE `keys` (
  3. `id` int(11) NOT NULL,
  5. `key` varchar(40) NOT NULL,
  7. `level` int(2) NOT NULL,
  9. `ignore_limits` tinyint(1) NOT NULL DEFAULT '0',
  11. `is_private_key` tinyint(1) NOT NULL DEFAULT '0',
  13. `ip_addresses` text,
  15. `date_created` int(11) NOT NULL
  17. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

 

  1. CREATE TABLE `logs` (
  3. `id` int(11) NOT NULL,
  5. `uri` varchar(255) NOT NULL,
  7. `method` varchar(6) NOT NULL,
  9. `params` text,
  11. `api_key` varchar(40) NOT NULL,
  13. `ip_address` varchar(45) NOT NULL,
  15. `time` int(11) NOT NULL,
  17. `rtime` float DEFAULT NULL,
  19. `authorized` varchar(1) NOT NULL,
  21. `response_code` smallint(3) DEFAULT '0'
  23. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;

The table Keys will be used for storing the API key, and the Logs table will hold the logs of the request(s) received by the server.

Now open up application / database.php and type in your hostname, dbname and password



The next step is the setup of authentication. For this, open up application / autoload.php and change this line of code

  1. $autoload['libraries'] = array( );

To this

  1. $autoload['libraries'] = array('database');

Now go to application / rest.php and set the following entities as shown

  1. $config['rest_enable_keys'] = TRUE;
  2. $config['rest_logs_table'] = 'logs';
  3. $config['rest_auth'] = 'basic';
  4. $config['auth_source'] = '';

The authentication is now ready. Nest up is the creation of the model and HTTP calls.

Setup HTTP Calls

I will now create two files.

Go to application/controllers and create a new file with the name of api.php. Paste the following code in it.

  1. <?php
  2. defined('BASEPATH') OR exit('No direct script access allowed');
  4. require(APPPATH.'/libraries/REST_Controller.php');
  5. class Api extends REST_Controller
  6. {
  8. public function __construct() {
  9. parent::__construct();
  10. $this->load->model('user_model');
  12. }
  13. public function user_get(){
  14. $r = $this->user_model->read();
  15. $this->response($r);
  16. }
  17. public function user_put(){
  18. $id = $this->uri->segment(3);
  20. $data = array('name' => $this->input->get('name'),
  21. 'pass' => $this->input->get('pass'),
  22. 'type' => $this->input->get('type')
  23. );
  25. $r = $this->user_model->update($id,$data);
  26. $this->response($r);
  27. }
  29. public function user_post(){
  30. $data = array('name' => $this->input->post('name'),
  31. 'pass' => $this->input->post('pass'),
  32. 'type' => $this->input->post('type')
  33. );
  34. $r = $this->user_model->insert($data);
  35. $this->response($r);
  36. }
  37. public function user_delete(){
  38. $id = $this->uri->segment(3);
  39. $r = $this->user_model->delete($id);
  40. $this->response($r);
  41. }
  44. }

Next, go to application/models and paste the following code in it.

  1. <?php
  3. defined('BASEPATH') OR exit('No direct script access allowed');
  7. /**
  9. *
  11. */
  13. class User_model extends CI_Model
  15. {
  17. public function read(){
  21. $query = $this->db->query("select * from `tbl_user`");
  23. return $query->result_array();
  25. }
  29. public function insert($data){
  33. $this->user_name = $data['name']; // please read the below note
  35. $this->user_password = $data['pass'];
  37. $this->user_type = $data['type'];
  41. if($this->db->insert('tbl_user',$this))
  43. {
  45. return 'Data is inserted successfully';
  47. }
  49. else
  51. {
  53. return "Error has occured";
  55. }
  57. }
  61. public function update($id,$data){
  65. $this->user_name = $data['name']; // please read the below note
  67. $this->user_password = $data['pass'];
  69. $this->user_type = $data['type'];
  71. $result = $this->db->update('tbl_user',$this,array('user_id' => $id));
  73. if($result)
  75. {
  77. return "Data is updated successfully";
  79. }
  81. else
  83. {
  85. return "Error has occurred";
  87. }
  89. }
  93. public function delete($id){
  97. $result = $this->db->query("delete from `tbl_user` where user_id = $id");
  99. if($result)
  101. {
  103. return "Data is deleted successfully";
  105. }
  107. else
  109. {
  111. return "Error has occurred";
  113. }
  115. }
  119. }

Testing the HTTP Calls

To test the HTTP calls of the API, I will use Postman.Go to the Postman, Set the method to GET , then set the authentication and API key as shown below:

Now to test the POST request, set the request to POST and add the authentication and API key. Fill in the variables as shown below:

Next, I will test the PUT request. Pass the id in the 3rd segment of the URL, set the request to PUT, set the authentication and the API key and fill in the parameters as shown below:

To test the DELETE request, pass the id in the 3rd segment of the URL, set the request to DELETE, set the authentication and the API key and fill in the parameters as shown below:

To Sum Up

In this tutorial. I described how you could setup authentication for a REST API in Codeigniter. I created four API calls for data manipulation.

If you need any help with the code or the idea of implementing your own RESTful API in Codeigniter, do leave a comment below.

Source - https://www.cloudways.com/blog/rest-api-in-codeigniter/


Please Share this course

Share

It Looks like you have completed your course!! We have created Online series based on the above content. You can give a test and check your skill.




Be a Part of CollegeSpike by giving your precious comment here and help us in improving our content.