Skip to content
PHP HTTP client library for cybozu.com API.
Branch: master
Clone or download
Latest commit 6c7611c Jul 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Fixes circle ci config Jan 17, 2019
src Add cursor API Jul 17, 2019
tests Add cursor API Jul 17, 2019
.gitignore Remove composer.lock Oct 4, 2015
.scrutinizer.yml first commit Sep 30, 2015
LICENSE first commit Sep 30, 2015
README.md Fixes doc Jan 17, 2019
composer.json Change email Jul 16, 2019
parameters.dist.yml Multiple files get and post Dec 5, 2017
phpunit.xml.dist Add PHPUnit bootstrap Jul 17, 2019

README.md

Cybozu HTTP client for PHPSoftware License

Circle CI Scrutinizer Code Quality Code Coverage Build Status

Cybozu HTTP is a PHP HTTP client library for cybozu.com API.

cybozu.com API Documentation

Japanese English

Available API

  • kintone API
  • User API

If you want to use Garoon API, please send Pull Request.

Requirements

  • PHP >=7.1
  • Composer
  • To use the PHP stream handler, allow_url_fopen must be enabled in your system's php.ini.
  • To use the cURL handler, you must have a recent version of cURL >= 7.19.4 compiled with OpenSSL and zlib.

Installation

The recommended way to install Cybozu HTTP is with Composer. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.

    $ curl -sS https://getcomposer.org/installer | php
    $ mv composer.phar /usr/local/bin/composer

You can add Cybozu HTTP as a dependency using the composer

    $ composer require ochi51/cybozu-http

Alternatively, you can specify Cybozu HTTP as a dependency in your project's existing composer.json file:

    {
       "require": {
          "ochi51/cybozu-http": "^1.4"
       }
    }

After installing, you need to require Composer's autoloader:

    require 'vendor/autoload.php';

Quick start

    $api = new \CybozuHttp\Api\KintoneApi(new \CybozuHttp\Client([
        'domain' => 'cybozu.com',
        'subdomain' => 'your-subdomain',
        'login' => 'your-login-name',
        'password' => 'your-password',
    ]));
    
    // get record that kintone app id is 100 and record id is 1.
    $record = $api->record()->get(100, 1);

Usage

@todo

Testing

To run the tests, you need to following process.

  • Prepare your kintone account.
    • Free trial is here
  • Create kintone space template. (Enable multiple thread)
  • Create graph.
  • Edit parameters.yml.

Run the following command from the project folder.

    $ php ./bin/phpunit

TODO

  • Japanese documentation.

License

The MIT License (MIT). Please see LICENSE for more information.

You can’t perform that action at this time.