Download the PHP package flat/api without Composer

On this page you can find all versions of the php package flat/api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of flat/api

Informations about the package api

PHP Client for the Flat REST API

Build Status Packagist

The Flat API allows you to easily extend the abilities of the Flat Platform, with a wide range of use cases including the following:

You can find the API reference including code samples and our OpenAPI Specification at the following url: https://flat.io/developers/api/reference.

To request some API credentials, please visit https://flat.io/developers.

This Python package is automatically generated by the Swagger Codegen project.

Requirements

PHP 5.6.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

Then run composer install

Manual Installation

Download the files and include autoload.php:

Tests

To run the unit tests:

Getting Started

Please follow the installation procedure and then run the following:

Documentation for API Endpoints

All URIs are relative to https://api.flat.io/v2

Class Method HTTP request Description
AccountApi getAuthenticatedUser GET /me Get current user profile
ClassApi activateClass POST /classes/{class}/activate Activate the class
ClassApi addClassUser PUT /classes/{class}/users/{user} Add a user to the class
ClassApi archiveClass POST /classes/{class}/archive Archive the class
ClassApi copyAssignment POST /classes/{class}/assignments/{assignment}/copy Copy an assignment
ClassApi createAssignment POST /classes/{class}/assignments Assignment creation
ClassApi createClass POST /classes Create a new class
ClassApi createSubmission PUT /classes/{class}/assignments/{assignment}/submissions Create or edit a submission
ClassApi deleteClassUser DELETE /classes/{class}/users/{user} Remove a user from the class
ClassApi editSubmission PUT /classes/{class}/assignments/{assignment}/submissions/{submission} Edit a submission
ClassApi enrollClass POST /classes/enroll/{enrollmentCode} Join a class
ClassApi getClass GET /classes/{class} Get the details of a single class
ClassApi getScoreSubmissions GET /scores/{score}/submissions List submissions related to the score
ClassApi getSubmission GET /classes/{class}/assignments/{assignment}/submissions/{submission} Get a student submission
ClassApi getSubmissions GET /classes/{class}/assignments/{assignment}/submissions List the students' submissions
ClassApi listAssignments GET /classes/{class}/assignments Assignments listing
ClassApi listClassStudentSubmissions GET /classes/{class}/students/{user}/submissions List the submissions for a student
ClassApi listClasses GET /classes List the classes available for the current user
ClassApi unarchiveClass DELETE /classes/{class}/archive Unarchive the class
ClassApi updateClass PUT /classes/{class} Update the class
CollectionApi addScoreToCollection PUT /collections/{collection}/scores/{score} Add a score to the collection
CollectionApi createCollection POST /collections Create a new collection
CollectionApi deleteCollection DELETE /collections/{collection} Delete the collection
CollectionApi deleteScoreFromCollection DELETE /collections/{collection}/scores/{score} Delete a score from the collection
CollectionApi editCollection PUT /collections/{collection} Update a collection's metadata
CollectionApi getCollection GET /collections/{collection} Get collection details
CollectionApi listCollectionScores GET /collections/{collection}/scores List the scores contained in a collection
CollectionApi listCollections GET /collections List the collections
CollectionApi untrashCollection POST /collections/{collection}/untrash Untrash a collection
GroupApi getGroupDetails GET /groups/{group} Get group information
GroupApi getGroupScores GET /groups/{group}/scores List group's scores
GroupApi listGroupUsers GET /groups/{group}/users List group's users
OrganizationApi createLtiCredentials POST /organizations/lti/credentials Create a new couple of LTI 1.x credentials
OrganizationApi createOrganizationInvitation POST /organizations/invitations Create a new invitation to join the organization
OrganizationApi createOrganizationUser POST /organizations/users Create a new user account
OrganizationApi listLtiCredentials GET /organizations/lti/credentials List LTI 1.x credentials
OrganizationApi listOrganizationInvitations GET /organizations/invitations List the organization invitations
OrganizationApi listOrganizationUsers GET /organizations/users List the organization users
OrganizationApi removeOrganizationInvitation DELETE /organizations/invitations/{invitation} Remove an organization invitation
OrganizationApi removeOrganizationUser DELETE /organizations/users/{user} Remove an account from Flat
OrganizationApi revokeLtiCredentials DELETE /organizations/lti/credentials/{credentials} Revoke LTI 1.x credentials
OrganizationApi updateOrganizationUser PUT /organizations/users/{user} Update account information
ScoreApi addScoreCollaborator POST /scores/{score}/collaborators Add a new collaborator
ScoreApi addScoreTrack POST /scores/{score}/tracks Add a new video or audio track to the score
ScoreApi createScore POST /scores Create a new score
ScoreApi createScoreRevision POST /scores/{score}/revisions Create a new revision
ScoreApi deleteScore DELETE /scores/{score} Delete a score
ScoreApi deleteScoreComment DELETE /scores/{score}/comments/{comment} Delete a comment
ScoreApi deleteScoreTrack DELETE /scores/{score}/tracks/{track} Remove an audio or video track linked to the score
ScoreApi editScore PUT /scores/{score} Edit a score's metadata
ScoreApi forkScore POST /scores/{score}/fork Fork a score
ScoreApi gerUserLikes GET /users/{user}/likes List liked scores
ScoreApi getGroupScores GET /groups/{group}/scores List group's scores
ScoreApi getScore GET /scores/{score} Get a score's metadata
ScoreApi getScoreCollaborator GET /scores/{score}/collaborators/{collaborator} Get a collaborator
ScoreApi getScoreCollaborators GET /scores/{score}/collaborators List the collaborators
ScoreApi getScoreComments GET /scores/{score}/comments List comments
ScoreApi getScoreRevision GET /scores/{score}/revisions/{revision} Get a score revision
ScoreApi getScoreRevisionData GET /scores/{score}/revisions/{revision}/{format} Get a score revision data
ScoreApi getScoreRevisions GET /scores/{score}/revisions List the revisions
ScoreApi getScoreSubmissions GET /scores/{score}/submissions List submissions related to the score
ScoreApi getScoreTrack GET /scores/{score}/tracks/{track} Retrieve the details of an audio or video track linked to a score
ScoreApi getUserScores GET /users/{user}/scores List user's scores
ScoreApi listScoreTracks GET /scores/{score}/tracks List the audio or video tracks linked to a score
ScoreApi markScoreCommentResolved PUT /scores/{score}/comments/{comment}/resolved Mark the comment as resolved
ScoreApi markScoreCommentUnresolved DELETE /scores/{score}/comments/{comment}/resolved Mark the comment as unresolved
ScoreApi postScoreComment POST /scores/{score}/comments Post a new comment
ScoreApi removeScoreCollaborator DELETE /scores/{score}/collaborators/{collaborator} Delete a collaborator
ScoreApi untrashScore POST /scores/{score}/untrash Untrash a score
ScoreApi updateScoreComment PUT /scores/{score}/comments/{comment} Update an existing comment
ScoreApi updateScoreTrack PUT /scores/{score}/tracks/{track} Update an audio or video track linked to a score
UserApi gerUserLikes GET /users/{user}/likes List liked scores
UserApi getUser GET /users/{user} Get a public user profile
UserApi getUserScores GET /users/{user}/scores List user's scores

Documentation For Models

Documentation For Authorization

OAuth2

Author

[email protected]

All versions of api with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package flat/api contains the following files

Loading the files please wait ....