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

ActiveLibrary[API Development](/categories/api)

ma-residence/php-sdk
====================

2.4.2(2y ago)13251PHPPHP 8.\*CI failing

Since Jun 21Pushed 2y ago8 watchersCompare

[ Source](https://github.com/ma-residence/php-sdk)[ Packagist](https://packagist.org/packages/ma-residence/php-sdk)[ RSS](/packages/ma-residence-php-sdk/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (10)Dependencies (8)Versions (33)Used By (0)

php-sdk
=======

[](#php-sdk)

Official PHP SDK for [ma-residence](https://www.ma-residence.fr)'s API.

Get started
-----------

[](#get-started)

To use [ma-residence's API](https://github.com/ma-residence/api), you have to register your application. When registering your application, you will obtain a ***client\_id*** and ***client\_secret***. The ***client\_id*** and ***client\_secret*** will be necessary to use the API.

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

[](#installation)

Edit your `composer.json` :

```
{
    "require": {
        "ma-residence/php-sdk": "2.0.*"
    },
    "repositories": [
        {
            "type": "vcs",
            "url":  "https://github.comma-residence/php-sdk.git",
            "no-api": true
        }
    ]
}
```

Composer Update
---------------

[](#composer-update)

docker run -it --name docker-php-sdk --rm -v "$PWD/php-sdk:/user/src/php-sdk" -w /user/src/php-sdk composer composer update

Usage
-----

[](#usage)

```