https://github.com/kiriminaja/php
KiriminAja API Client for PHP - Pickup Request, Tracking, Mapping and Integration Tools
https://github.com/kiriminaja/php
codeigniter composer kiriminaja laravel packagist php php-library rest-api symfony
Last synced: about 1 month ago
JSON representation
KiriminAja API Client for PHP - Pickup Request, Tracking, Mapping and Integration Tools
- Host: GitHub
- URL: https://github.com/kiriminaja/php
- Owner: kiriminaja
- License: mit
- Created: 2022-10-12T09:49:39.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T09:18:10.000Z (about 2 months ago)
- Last Synced: 2025-03-28T10:15:16.782Z (about 2 months ago)
- Topics: codeigniter, composer, kiriminaja, laravel, packagist, php, php-library, rest-api, symfony
- Language: PHP
- Homepage: https://developer.kiriminaja.com
- Size: 130 KB
- Stars: 11
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# KiriminAja API SDK
This library is the abstraction of KiriminAja API for access from applications written with PHP.
## Getting Started
### Requirements
PHP 8.0 and later
### Installation
Install `kiriminaja-php` with composer by following command:
```bash
composer require kiriminaja/kiriminaja-php
```
or add it manually in your composer.json file.
### Usage
Configure package with your account's secret key obtained from KiriminAja Document Assignment.
```php
$mode = 'production' ? Mode::Production : Mode::Staging;
KiriminAjaConfig::setMode($mode)::setApiTokenKey('YOUR_KEY');
```
You can read our test case for the examples https://github.com/kiriminaja/php/blob/main/tests/Services/Shipping/RequestPickupService/RequestPickupServiceSuccessTest.php
### Contributing
For any requests, bugs, or comments, please open an [issue](https://github.com/kiriminaja/kiriminaja-php/issues) or [submit a pull request](https://github.com/kiriminaja/kiriminaja-php/pulls).
### Installing Packages
Before you start to code, run this command to install all of the required packages. Make sure you have `composer` installed in your computer
```bash
composer install
```
### Tests
#### Running test suite:
```bash
vendor\bin\phpunit tests
```