PHPackages                             kiubi/php-sdk - 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. kiubi/php-sdk

ActiveLibrary[API Development](/categories/api)

kiubi/php-sdk
=============

PHP SDK for Kiubi API

v2.0.1(4y ago)264MITPHPPHP >=5.4.0

Since Jul 12Pushed 1mo ago2 watchersCompare

[ Source](https://github.com/Kiubi/api-dbo-PHP)[ Packagist](https://packagist.org/packages/kiubi/php-sdk)[ RSS](/packages/kiubi-php-sdk/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (1)DependenciesVersions (3)Used By (0)

Kiubi API Developers Back-office Client PHP
===========================================

[](#kiubi-api-developers-back-office-client-php)

Description
-----------

[](#description)

La plateforme [Kiubi](http://www.kiubi.com) fournit l'[API DBO](https://api.kiubi.com/console) aux développeurs afin d'interconnecter la plateforme avec leurs applications. Cette API leur fournis un accès direct et sécurisé aux données de tous leurs sites.

L'API DBO de Kiubi est de type REST supportant le format JSON. Afin de faciliter son utilisation, Kiubi propose une librairie PHP complète permettant la récupération des données via l'API de façon simple et optimisé. Pour en savoir plus, vous pouvez [consulter la documentation en ligne](https://aide.kiubi.com/api-dev-generalites.html).

Console
-------

[](#console)

Kiubi possède un environnement de bac à sable pour tester et débugger les appels à l'API. L'accès se fait à partir de l'adresse :

L'accès à la console est public mais l'exécution de requêtes nécessite un compte l'ouverture d'un compte sur la Plateforme.

Pré-requis
----------

[](#pré-requis)

- Un environnement pouvant exécuter du code PHP
- PHP avec l'extension cURL (PHP >= 5.4)
- Une clé API valide

Chaque utilisateur ayant un compte Back-office a la possibilité de créer et gérer ses clés API dans son profil utilisateur afin d'utiliser l'API DBO.

Déploiement
-----------

[](#déploiement)

La librairie peut être simple déployée avec composer :

```
composer require kiubi/php-sdk

```

Utilisation
-----------

[](#utilisation)

Le client PHP est composé de plusieurs classes permettant de requêter l'API DBO :

- Le client :

    ```
      class Api {

      }

    ```
- La réponse :

    ```
      class Response {

      }

    ```
- La gestion de l'upload de fichiers :

    ```
      class File {

      }

    ```

Méthodes disponibles
--------------------

[](#méthodes-disponibles)

Voici la liste des méthodes disponibles dans le client PHP :

- Le client :

    - get() : Permet de lancer une requête vers l'API en méthode http GET
    - post() : Permet de lancer une requête vers l'API en méthode http POST
    - put() : Permet de lancer une requête vers l'API en méthode http PUT
    - delete() : Permet de lancer une requête vers l'API en méthode http DELETE
    - query() : Structure une requête et lance son exécution
    - *performQuery()* : Exécute une requête vers l'API en utilisant cURL (méthode protégée)
    - *getJsonResponse()* : Retourne un object `Response` permettant de traiter la réponse à une requête (méthode protégée)
    - *prepareHeaders()* : Prépare les entêtes pour une requête multipart (méthode protégée)
    - *preparePayload()* : Prépare le contenu pour une requête multipart (méthode protégée)
    - *flattenParams()* : Transforme les paramètres multidimentionnels en paramètre simple pour une requête multipart (méthode protégée)
    - setAccessToken() : Définie la clé api utilisée pour les requêtes
    - getAccessToken() : Retourne la clé api en cours d'utilisation
    - getRateRemaining() : Retourne le quota de requête restant
    - getPage() : Permet de récupérer une page précise d'une liste de résultat
    - getNextPage() : Permet de récupérer la page suivante d'une liste de résultat
    - getPreviousPage() : Permet de récupérer la page précédent d'une liste de résultat
    - getFirstPage() : Permet de récupérer la première page d'une liste de résultat
    - getLastPage() : Permet de récupérer la dernière page d'une liste de résultat
    - hasNextPage() : Détermine si la liste de résultat comporte une page suivante
    - hasPreviousPage() : Détermine si la liste de résultat comporte une page précédente
    - getNavigationPage() : Méthode interne qui lance les requêtes de navigation
- La réponse :

    - getHeaders() : Retourne la liste des entêtes HTTP de la réponse
    - getError() : Retourne l'erreur survenues lors de la requête
    - getMeta() : Récupère les données meta de la réponse
    - getData() : Récupère les données de la réponse
    - getHttpCode() : Retourne le code HTTP réel de la réponse
    - hasFailed() : Indique si la requête à échouée
    - hasSucceed() : Indique si la requête s'est bien déroulé
- La gestion des uploads :

    - getContentSize() : Retourne la taille du fichier en octets
    - getFilename() : Retourne le nom du fichier
    - getContentType() : Retourne le type mime du fichier
    - getContent() : Retourne le contenu du fichier

Exemples
--------

[](#exemples)

### Récupération de la liste de ses sites

[](#récupération-de-la-liste-de-ses-sites)

```
$token = '---TOKEN---';   // Votre clé API

$api = new Kiubi\Api($token);
$query = $api->get('sites');
if ($query->hasFailed()) {
    $err = $query->getError();
    echo $err['message']."\n";
}
if ($query->hasSucceed()) {
    foreach($query->getData() as $menu) {
        echo $menu['name']."\n";
    }
}

```

### Récupération des menus du Site web

[](#récupération-des-menus-du-site-web)

```
$token = '---TOKEN---';   // Votre clé API
$site  = 'mon-code-site'; // Le code site

$api = new Kiubi\Api($token);
$query = $api->get('sites/'.$site.'/cms/menus');
if ($query->hasFailed()) {
    $err = $query->getError();
    echo $err['message']."\n";
}
if ($query->hasSucceed()) {
    foreach($query->getData() as $menu) {
        echo $menu['name']."\n";
    }
}

```

### Récupération des commandes d'un site

[](#récupération-des-commandes-dun-site)

```
$token = '---TOKEN---';   // Votre clé API
$site  = 'mon-code-site'; // Le code site

$api = new Kiubi\Api($token);
$response = $api->get('sites/'.$site.'/checkout/orders');
if ($response->hasSucceed()) {
    do {
        $next = false;
        $data = $response->getData();
        foreach($data as $cmd) {
            echo $cmd['creation_date'].' - '.$cmd['reference'])."\n";
        }
        if ($api->hasNextPage($response) && $api->getRateRemaining()>0) {
            $next = true;
            $response = $api->getNextPage($response);
        }
    } while($next && $response->hasSucceed());
}

```

### Envoi d'un fichier dans la médiathèque d'un site

[](#envoi-dun-fichier-dans-la-médiathèque-dun-site)

```
$token = '---TOKEN---';   // Votre clé API
$site  = 'mon-code-site'; // Le code site

$api = new Kiubi\Api($token);
$response = $api->post('sites/'.$site.'/media/files', array('name'=>'fichier', 'folder_id'=>2, 'file'=>new File('/path/to/file.txt'));
if ($response->hasSucceed()) {
    $media_id = $response->getData();
}

```

###  Health Score

34

—

LowBetter than 75% of packages

Maintenance59

Moderate activity, may be stable

Popularity12

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity48

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~63 days

Total

2

Last Release

1755d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/663e753c3bcdab73fffe17564d5c9d9459372137bb3935467372508351fbf5f9?d=identicon)[Leguman](/maintainers/Leguman)

---

Top Contributors

[![jetwitaussi](https://avatars.githubusercontent.com/u/1422884?v=4)](https://github.com/jetwitaussi "jetwitaussi (1 commits)")[![sbraun](https://avatars.githubusercontent.com/u/389084?v=4)](https://github.com/sbraun "sbraun (1 commits)")

### Embed Badge

![Health badge](/badges/kiubi-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/kiubi-php-sdk/health.svg)](https://phpackages.com/packages/kiubi-php-sdk)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M20](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172445.0k15](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)