whatcoloris/api-client

PHP client for the WhatColorIs REST API.

dev-main 2022-09-30 08:58 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^7.4
• myclabs/php-enum: ^1.8
• psr/http-client: ^1.0
• psr/log: ^2.0 || ^3.0

Requires (Dev)

• phpstan/phpstan: ^1.0
• phpunit/phpunit: ^9.0
• rector/rector: ^0.12
• symplify/easy-coding-standard: ^11.0

MIT

• Tobias Köngeter

README

WhatColorIs API Client

A PHP client for the WhatColorIs REST API.

Installation

This library is made for the use with Composer. Add it to your project by running $ composer require whatcoloris/api-client.

Usage

Please note: this library requires you to have a valid API token.

Set up the client

Add you API token at first and initialize the client then:

<?php

use WhatColorIs\APIClient\ColorInformationLoader\WhatColorIsAPI;

WhatColorIsAPI::setApiKey('token');

$whatColorIsAPI = new WhatColorIsAPI();

Request a color system

Request information about a specific color system:

<?php

use WhatColorIs\APIClient\Enum\ColorSystem;

$response = $whatColorIsAPI->requestColorSystem(ColorSystem::PANTONE());

Request a color value

Request information about a specific color:

<?php

use WhatColorIs\APIClient\Enum\ColorSystem;

$response = $whatColorIsAPI->requestColorValue(ColorSystem::PANTONE(), 'PANTONE 215 C');

Integration

You don't need to handle the response data by your own. The Bit&Black Colors library has a perfect integration and allows to handle the colors in an object-oriented way.

Available color systems

The available color systems are:

• CIELAB
• CMYK
• HEX
• HKS
• HSL
• PANTONE
• RAL
• RGB

Help

If you have any questions, feel free to contact us under [e-mail].

Further information about Bit&Black can be found under www.bitandblack.com.