flat-api v0.6.0

JavaScript (Browser & Node.js) Client for the Flat REST API

The Flat API allows you to easily extend the abilities of the Flat Platform, 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: https://flat.io/developers/api/reference.

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

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

Installation

For Node.js

npm

$ npm install flat-api --save

git

$ npm install git://github.com/FlatIO/api-client-js --save

For browser

bower

$ bower install flat-api

git / github

The library also works in the browser environment via npm and browserify. A build is available in the build directory, you can also rebuild the library:

$ npm install -d && npm run build
$ ls -1 build
flat-api.js
flat-api.js.map
flat-api.min.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var FlatApi = require('flat-api');

// Configure OAuth2 access token for authorization
FlatApi.ApiClient.instance.authentications.OAuth2.accessToken = 'YOUR_ACCES_TOKEN';

var flatAccountApi = new FlatApi.AccountApi();
flatAccountApi.getAuthenticatedUser(function(error, data, response) {
  if (error) {
    console.error(error);
  }
  else {
    console.log('Successfully retrieved user profile: ', data);
  }
});

Documentation for API Endpoints

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

Documentation for Models

• FlatApi.Assignment
• FlatApi.AssignmentCopy
• FlatApi.AssignmentCreation
• FlatApi.AssignmentSubmission
• FlatApi.AssignmentSubmissionUpdate
• FlatApi.ClassAttachmentCreation
• FlatApi.ClassCreation
• FlatApi.ClassDetails
• FlatApi.ClassDetailsCanvas
• FlatApi.ClassDetailsClever
• FlatApi.ClassDetailsGoogleClassroom
• FlatApi.ClassDetailsGoogleDrive
• FlatApi.ClassDetailsLti
• FlatApi.ClassRoles
• FlatApi.ClassState
• FlatApi.ClassUpdate
• FlatApi.Collection
• FlatApi.CollectionCapabilities
• FlatApi.CollectionCreation
• FlatApi.CollectionModification
• FlatApi.CollectionPrivacy
• FlatApi.CollectionTitle
• FlatApi.CollectionType
• FlatApi.FlatErrorResponse
• FlatApi.FlatLocales
• FlatApi.GoogleClassroomCoursework
• FlatApi.GoogleClassroomSubmission
• FlatApi.Group
• FlatApi.GroupDetails
• FlatApi.GroupType
• FlatApi.LicenseMode
• FlatApi.LicenseSources
• FlatApi.LmsName
• FlatApi.LtiCredentials
• FlatApi.LtiCredentialsCreation
• FlatApi.MediaAttachment
• FlatApi.MediaScoreSharingMode
• FlatApi.OrganizationInvitation
• FlatApi.OrganizationInvitationCreation
• FlatApi.OrganizationRoles
• FlatApi.ResourceCollaboratorCreation
• FlatApi.ResourceRights
• FlatApi.ResourceSharingKey
• FlatApi.ScoreComment
• FlatApi.ScoreCommentContext
• FlatApi.ScoreCommentCreation
• FlatApi.ScoreCommentUpdate
• FlatApi.ScoreCommentsCounts
• FlatApi.ScoreCreation
• FlatApi.ScoreCreationType
• FlatApi.ScoreData
• FlatApi.ScoreDataEncoding
• FlatApi.ScoreFork
• FlatApi.ScoreLicense
• FlatApi.ScoreLikesCounts
• FlatApi.ScoreModification
• FlatApi.ScorePrivacy
• FlatApi.ScoreRevision
• FlatApi.ScoreRevisionCreation
• FlatApi.ScoreRevisionStatistics
• FlatApi.ScoreSource
• FlatApi.ScoreSummary
• FlatApi.ScoreTrack
• FlatApi.ScoreTrackCreation
• FlatApi.ScoreTrackPoint
• FlatApi.ScoreTrackState
• FlatApi.ScoreTrackType
• FlatApi.ScoreTrackUpdate
• FlatApi.ScoreViewsCounts
• FlatApi.UserAdminUpdate
• FlatApi.UserBasics
• FlatApi.UserCreation
• FlatApi.UserDetailsAdminLicense
• FlatApi.UserInstruments
• FlatApi.ResourceCollaborator
• FlatApi.ScoreDetails
• FlatApi.UserPublicSummary
• FlatApi.UserDetailsAdmin
• FlatApi.UserPublic
• FlatApi.UserDetails

Documentation for Authorization

OAuth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://flat.io/auth/oauth
• Scopes:
  • account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile.
  • account.education_profile: Provides access to the basic person's education profile and public organization information.
  • scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores.
  • scores.social: Allow to post comments and like scores
  • scores: Full, permissive scope to access all of a user's scores.
  • collections.readonly: Allow read-only access to a user's collections.
  • collections.add_scores: Allow to add scores to a user's collections.
  • collections: Full, permissive scope to access all of a user's collections.
  • edu.classes: Full, permissive scope to manage the classes.
  • edu.classes.readonly: Read-only access to the classes.
  • edu.assignments: Read-write access to the assignments and submissions.
  • edu.assignments.readonly: Read-only access to the assignments and submissions.
  • edu.admin: Full, permissive scope to manage all the admin of an organization.
  • edu.admin.lti: Access and manage the LTI Credentials for an organization.
  • edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization.
  • edu.admin.users: Access and manage the users and invitations of the organization.
  • edu.admin.users.readonly: Read-only access to the users and invitations of the organization.