PHPackages                             protacon/vf-rest - 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. protacon/vf-rest

ActiveLibrary[API Development](/categories/api)

protacon/vf-rest
================

ValueFrame REST API component

0.5.0(3y ago)017.9k↓25%[1 PRs](https://github.com/by-pinja/vf-rest/pulls)MITPHP >=8.1

Since Jan 12Compare

[ Source](https://github.com/by-pinja/vf-rest)[ Packagist](https://packagist.org/packages/protacon/vf-rest)[ RSS](/packages/protacon-vf-rest/feed)WikiDiscussions Synced yesterday

READMEChangelog (1)Dependencies (4)Versions (9)Used By (0)

What is this
============

[](#what-is-this)

[![MIT licensed](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](./LICENSE)[![Total Downloads](https://camo.githubusercontent.com/9cdcd4aca4c01779888877670f8506bbd53324155557b23f3eebd90ce1b5bda7/68747470733a2f2f706f7365722e707567782e6f72672f70726f7461636f6e2f76662d726573742f646f776e6c6f616473)](https://packagist.org/packages/protacon/vf-rest)[![Latest Stable Version](https://camo.githubusercontent.com/6778065c6ae321bccc6874d5d09b96fc5c82ee12cf640818a6aac7ad19c0321c/68747470733a2f2f706f7365722e707567782e6f72672f70726f7461636f6e2f76662d726573742f762f737461626c65)](https://packagist.org/packages/protacon/vf-rest)[![Latest Unstable Version](https://camo.githubusercontent.com/94d89d4b09bbc16b7f77014321c1aec76feead9975d8e5d7951f62169983e309/68747470733a2f2f706f7365722e707567782e6f72672f70726f7461636f6e2f76662d726573742f762f756e737461626c65)](https://packagist.org/packages/protacon/vf-rest)

Simple library for [ValueFrame REST API](https://support.valueframe.fi/support/solutions/articles/77000527771-rest-rajapinnan-k%C3%A4ytt%C3%B6).

Basically this is a wrapper for [guzzlehttp/guzzle](http://docs.guzzlephp.org/en/stable/) - this library just adds necessary headers to each request.

Table of Contents
-----------------

[](#table-of-contents)

- [What is this?](#what-is-this)
    - [Table of Contents](#table-of-contents)
    - [Requirements](#requirements)
    - [Installation](#installation)
    - [Usage](#usage)
    - [Development](#development)
        - [IDE](#ide)
        - [PHP Code Sniffer](#php-code-sniffer)
        - [Testing](#testing)
        - [Metrics](#metrics)
    - [Authors](#authors)
    - [License](#license)

Requirements
------------

[](#requirements)

- PHP 7.3 or higher
- [Composer](https://getcomposer.org/)

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

[](#installation)

The recommended way to install this library 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.

```
# Install Composer
curl -sS https://getcomposer.org/installer | php
```

You can add this library as a dependency to your project using following command:

```
composer require protacon/vf-rest
```

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

```
require 'vendor/autoload.php';
```

Note that this is only needed if you're using this library as a stand-alone component - usually your framework (eg. [Symfony](https://www.symfony.com)) is already handling this part for you.

Usage
-----

[](#usage)

First of all you should read [official documentation](https://www.valueframe.fi/help/lisapalvelut/rest/)about [ValueFrame](https://www.valueframe.com/) REST API.

Simple usage example:

```