https://github.com/alexeevdv/carrot-quest-php-client

PHP client for carrotquest.io Web API
https://github.com/alexeevdv/carrot-quest-php-client

Last synced: about 1 month ago
JSON representation

PHP client for carrotquest.io Web API

• Host: GitHub
• URL: https://github.com/alexeevdv/carrot-quest-php-client
• Owner: alexeevdv
• License: mit
• Created: 2019-12-12T07:09:20.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-14T11:03:35.000Z (about 5 years ago)
• Last Synced: 2024-10-23T12:23:59.242Z (3 months ago)
• Language: PHP
• Homepage: https://carrotquest.io/developers/webapi/
• Size: 10.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# carrot-quest-php-client

[![Build Status](https://travis-ci.com/alexeevdv/carrot-quest-php-client.svg?branch=master)](https://travis-ci.com/alexeevdv/carrot-quest-php-client) 

[![codecov](https://codecov.io/gh/alexeevdv/carrot-quest-php-client/branch/master/graph/badge.svg)](https://codecov.io/gh/alexeevdv/carrot-quest-php-client)

![PHP 7.1](https://img.shields.io/badge/PHP-7.1-green.svg) 

![PHP 7.2](https://img.shields.io/badge/PHP-7.2-green.svg)

![PHP 7.3](https://img.shields.io/badge/PHP-7.3-green.svg)

![PHP 7.4](https://img.shields.io/badge/PHP-7.4-green.svg)

PHP client for carrotquest.io Web API

## Installation

The preferred way to install this extension is through [composer](http://getcomposer.org/download/).

Either run

```bash

$ php composer.phar require alexeevdv/carrot-quest-php-client "^0.1"

```

or add

```

"alexeevdv/carrot-quest-php-client": "^0.1"

```

to the ```require``` section of your `composer.json` file.

## Configuration

```php

$guzzle = new \GuzzleHttp\Client([

    'base_uri' => 'https://api.carrotquest.io',

]);

$apiClient = new \alexeevdv\CarrotQuest\Client(

    'your_auth_token_goes_here',

    $guzzle

);

```

## Implemented methods

### Setting user properties

https://carrotquest.io/developers/endpoints/users/props/

```php

interface ClientInterface

{

    public function userSetProperties(int $userId, array $properties, $isCarrotQuestUser = true): void;

}

```