PHPackages                             flat/api - 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. flat/api

ActiveLibrary[API Development](/categories/api)

flat/api
========

PHP client for the Flat REST API

0.8.2(8y ago)11762[1 PRs](https://github.com/FlatIO/api-client-php/pulls)Apache-2.0PHPPHP >=5.6

Since Apr 9Pushed 5y ago4 watchersCompare

[ Source](https://github.com/FlatIO/api-client-php)[ Packagist](https://packagist.org/packages/flat/api)[ Docs](https://github.com/FlatIO/api-client-php)[ RSS](/packages/flat-api/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (10)Dependencies (4)Versions (11)Used By (0)

PHP Client for the Flat REST API
================================

[](#php-client-for-the-flat-rest-api)

[![Build Status](https://camo.githubusercontent.com/bf50be5ba551aab4900c6792403dc5531f5f1a32d025d0120e51f7b9db811df7/68747470733a2f2f7472617669732d63692e6f72672f466c6174494f2f6170692d636c69656e742d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/FlatIO/api-client-php)[![Packagist](https://camo.githubusercontent.com/a01c4b1d44ef96045ffcb2f90fcfc8903a605eb57628325c15ed3a3b3e411644/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f666c61742f6170692e737667)](https://packagist.org/packages/flat/api)

The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:

- Creating and importing new music scores using MusicXML or MIDI files
- Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI)
- Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.

You can find the API reference including code samples and our OpenAPI Specification at the following url: .

To request some API credentials, please visit .

This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.

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

[](#requirements)

PHP 5.6.0 and later

Installation & Usage
------------------------

[](#installation--usage)

### Composer

[](#composer)

To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:

```
{
    "name": "Example Application",
    "description": "This is an example using the Flat API",
    "require": {
        "flat/api": "dev-master"
    }
}

```

Then run `composer install`

### Manual Installation

[](#manual-installation)

Download the files and include `autoload.php`:

```
require_once('/path/to/./vendor/autoload.php');
```

Tests
-----

[](#tests)

To run the unit tests:

```
composer install
./vendor/bin/phpunit

```

Getting Started
---------------

[](#getting-started)

Please follow the [installation procedure](#installation--usage) and then run the following:

```