Download the PHP package k7brasil/codeigniter3-api without Composer
On this page you can find all versions of the php package k7brasil/codeigniter3-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download k7brasil/codeigniter3-api
More information about k7brasil/codeigniter3-api
Files in k7brasil/codeigniter3-api
Package codeigniter3-api
Short Description CodeIgniter API Controller
License MIT
Homepage https://github.com/k7brasil/CodeIgniter3-API
Informations about the package codeigniter3-api
CodeIgniter API Controller v.1.1.8
This extension is powered by K Seven
.
Files
\application\libraries\API_Controller.php
\application\helpers\api_helper.php
\application\config\api.php
Token Documentation
\application\libraries\Authorization_Token.php
\application\config\jwt.php
- PHP-JWT Library
\application\third_party\php-jwt\
Change Log
Installation
You can install this project into your PC using [composer]().
The recommended way to install composer packages is:
Postman (Test)
chrome web store ou Install In PC (Recommended)
Requirements
- PHP 5.4 or greater
- CodeIgniter 3.0+
Note: The library is used in CodeIgniter v3.8 and PHP 5.6.8.
Simple API
Documentation
Setup API Request Methods
-
This Function by default request method
GET
- Set
API Request
MethodPOST, GET, ..
Use API Limit
Before using the limit in API, we need to load the codeigniter database library
.
You can also load the database library in the autoload config config/autoload.php
file.
After database library loaded, database must be set in database config file config/database.php
.
After creating and setting up a database, we need to create a table for API Limit [api_limit]
in the database. like this.
The name of the database table of api limit is api_limit
by default. Which we can change through the API configuration file [config/api.php]
. like this.
Now we can use API Limit Method.
Thus this API can be run only 10 times in 5 minutes. It on IP address
.
At API limit time argument
we can also use everyday
which will follow the api limit per day. On the same API address
Use API Key without Database
We can set the API key in the Request Header. by default, the name of the header is X-API-K
, which we can change in the API config file [config/api.php]
. like this
Use this code in your API Controller file.
Use API Key with Database
We can also check the API key by databases
. For this, we need to first create api_keys
table in MySQL. like this
The name of the database table of API Keys is api_keys
by default. Which we can change through the API configuration file [config/api.php]
. like this.
Set API keys in api_keys
database table And Use this code in your API Controller file.
Use Custom Function in API Key
Add Custom Data in API Responses
In response to the API, we can also add custom data to something like this.
API Output ::
API Return Data
This method is used to return data to api in which the response data is first
and the second
request status code.
Request Status Code List
Status Code | Status Text |
---|---|
200 | OK |
401 | UNAUTHORIZED |
404 | NOT FOUND |
408 | Request Timeout |
400 | BAD REQUEST |
405 | Method Not Allowed |
Using the Config file in the API key
- Create config file
\application\config\api_keys.php
- Use in API Controller like this
Reporting Issues
If you have a problem with this plugin or found any bug, please open an issue on GitHub.
License
CodeIgniter API Controller is licensed under MIT