PHPackages                             kiriminaja/kiriminaja-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. kiriminaja/kiriminaja-php

ActiveLibrary[API Development](/categories/api)

kiriminaja/kiriminaja-php
=========================

PHP clients for KiriminAja API

2.1.2(4w ago)1410.4k↓10.8%5MITPHPPHP >=8.1CI passing

Since Oct 12Pushed 1w agoCompare

[ Source](https://github.com/kiriminaja/php)[ Packagist](https://packagist.org/packages/kiriminaja/kiriminaja-php)[ Docs](https://kiriminaja.com)[ RSS](/packages/kiriminaja-kiriminaja-php/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (10)Dependencies (20)Versions (24)Used By (0)

KiriminAja PHP SDK
==================

[](#kiriminaja-php-sdk)

[![Total Downloads](https://camo.githubusercontent.com/6c9f16760d965da6ebebb650b99603c454c7996d9722e84bde3c372f3d9cc685/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6b6972696d696e616a612f6b6972696d696e616a612d706870)](https://packagist.org/packages/kiriminaja/kiriminaja-php)[![Latest Stable Version](https://camo.githubusercontent.com/661777d5f16433d6d1d4e0decc1cdf2230211d3798ad6ea13a82ef544ee22721/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6b6972696d696e616a612f6b6972696d696e616a612d706870)](https://packagist.org/packages/kiriminaja/kiriminaja-php)[![license](https://camo.githubusercontent.com/4fde73a3836a082f4b3ecd9e9ac1a22c40d406c43d9442a418ed75e9bbb87f8d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f6b6972696d696e616a612f6b6972696d696e616a612d706870)](LICENSE)

Official PHP SDK for the [KiriminAja](https://kiriminaja.com) logistics API.

Requirements
------------

[](#requirements)

- PHP 8.1+
- ext-json

Installation
------------

[](#installation)

```
composer require kiriminaja/kiriminaja-php
```

---

Quick Start
-----------

[](#quick-start)

Call `KiriminAjaConfig` once at app startup, then call any service method on the `KiriminAja` facade.

```
use KiriminAja\Base\Config\KiriminAjaConfig;
use KiriminAja\Base\Config\Cache\Mode;
use KiriminAja\Services\KiriminAja;

KiriminAjaConfig::setMode(Mode::Staging)::setApiTokenKey('YOUR_API_KEY');

// Use any service
$provinces = KiriminAja::getProvince();
```

---

Config Options
--------------

[](#config-options)

MethodDescription`KiriminAjaConfig::setMode($mode)``Mode::Staging` or `Mode::Production``KiriminAjaConfig::setApiTokenKey($key)`Your KiriminAja API key`KiriminAjaConfig::setBaseUrl($url)`Custom base URL (useful for proxy or self-hosted)`KiriminAjaConfig::setCacheDirectory($path)`Custom cache directory (useful if /tmp is not writable)`KiriminAjaConfig::disableCache()`Disable file-based caching entirely```
// Custom cache directory
KiriminAjaConfig::setCacheDirectory(__DIR__ . '/kiriminaja-cache');

// Or disable caching entirely
KiriminAjaConfig::disableCache();

KiriminAjaConfig::setMode(Mode::Production)::setApiTokenKey('YOUR_API_KEY');
```

### Custom Base URL

[](#custom-base-url)

If you need to route requests through a proxy or custom endpoint, set a custom base URL. This overrides the default URL resolved from the mode.

```
KiriminAjaConfig::setMode(Mode::Production)
    ::setApiTokenKey('YOUR_API_KEY')
    ::setBaseUrl('https://proxy.example.com');
```

---

Laravel Integration
-------------------

[](#laravel-integration)

The SDK auto-registers via Laravel package discovery — no manual provider registration needed.

### 1. Add to `config/services.php`

[](#1-add-to-configservicesphp)

```
'kiriminaja' => [
    'mode' => env('KIRIMINAJA_MODE', 'staging'),
    'api_key' => env('KIRIMINAJA_API_KEY', ''),
    'base_url' => env('KIRIMINAJA_BASE_URL'),
    'cache_store' => env('KIRIMINAJA_CACHE_STORE', 'laravel'),
    'cache_prefix' => env('KIRIMINAJA_CACHE_PREFIX', 'kiriminaja:'),
],
```

### 2. Add to your `.env`

[](#2-add-to-your-env)

```
KIRIMINAJA_MODE=staging
KIRIMINAJA_API_KEY=your-api-key-here
```

### 3. Use the SDK anywhere

[](#3-use-the-sdk-anywhere)

```
use KiriminAja\Services\KiriminAja;

$provinces = KiriminAja::getProvince();
```

### Config Reference (`services.kiriminaja`)

[](#config-reference-serviceskiriminaja)

KeyEnv VariableDefaultDescription`mode``KIRIMINAJA_MODE``staging``staging` or `production``api_key``KIRIMINAJA_API_KEY``""`Your KiriminAja API key`base_url``KIRIMINAJA_BASE_URL``null`Custom base URL (overrides mode-based URL)`cache_store``KIRIMINAJA_CACHE_STORE``laravel``laravel` (uses Laravel Cache) or `file` (file-based)`cache_prefix``KIRIMINAJA_CACHE_PREFIX``kiriminaja:`Cache key prefix (Laravel store only)---

CodeIgniter 4 Integration
-------------------------

[](#codeigniter-4-integration)

CodeIgniter 4 doesn't auto-discover Composer packages, so you wire the SDK up once during boot.

### 1. Publish the config

[](#1-publish-the-config)

Create `app/Config/KiriminAja.php`:

```