flat_api

FlatApi - the Ruby gem for the Flat 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, MIDI, Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore 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.

The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The schema of this API follows the OpenAPI Initiative (OAI) specification, you can use and work with compatible Swagger tools. This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec.

You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is available on Github.

Getting Started and learn more:

• API Overview and introduction
• Authentication (Personal Access Tokens or OAuth2)
• SDKs
• Rate Limits
• Changelog

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 2.20.0
• Package version: 0.3.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://flat.io/developers/docs/api/

gem install flat_api

To build the Ruby code into a gem:

gem build flat_api.gemspec

Then either install the gem locally:

gem install ./flat_api-0.3.0.gem

(for development, run gem install --dev ./flat_api-0.3.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'flat_api', '~> 0.3.0'

If the Ruby gem is hosted at a git repository: https://github.com/FlatIO/api-client-ruby, then add the following in the Gemfile:

gem 'flat_api', :git => 'https://github.com/FlatIO/api-client-ruby.git'

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Please follow the installation procedure and then run the following code:

# Load the gem
require 'flat_api'

# Setup authorization
FlatApi.configure do |config|
  # Configure OAuth2 access token for authorization: OAuth2
  config.access_token = 'YOUR ACCESS TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = FlatApi::AccountApi.new
opts = {
  only_id: true # Boolean | Only return the user id
}

begin
  #Get current user account
  result = api_instance.get_authenticated_user(opts)
  p result
rescue FlatApi::ApiError => e
  puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
end

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

• FlatApi::ApiAccessToken
• FlatApi::AppScopes
• FlatApi::Assignment
• FlatApi::AssignmentCapabilities
• FlatApi::AssignmentCapabilitiesCanPublishInClassError
• FlatApi::AssignmentCopy
• FlatApi::AssignmentCopyResponse
• FlatApi::AssignmentCopyToClass
• FlatApi::AssignmentCopyToResourceLibrary
• FlatApi::AssignmentSubmission
• FlatApi::AssignmentSubmissionComment
• FlatApi::AssignmentSubmissionCommentCreation
• FlatApi::AssignmentSubmissionComments
• FlatApi::AssignmentSubmissionHistory
• FlatApi::AssignmentSubmissionHistoryAttachment
• FlatApi::AssignmentSubmissionHistoryState
• FlatApi::AssignmentSubmissionLti
• FlatApi::AssignmentSubmissionPlaybackInner
• FlatApi::AssignmentSubmissionState
• FlatApi::AssignmentSubmissionUpdate
• FlatApi::AssignmentType
• FlatApi::AssignmentUpdate
• FlatApi::ClassAssignment
• FlatApi::ClassAssignmentAllOfCanvas
• FlatApi::ClassAssignmentAllOfLti
• FlatApi::ClassAssignmentAllOfMfc
• FlatApi::ClassAssignmentUpdate
• FlatApi::ClassAssignmentUpdateAllOfGoogleClassroom
• FlatApi::ClassAssignmentUpdateAllOfMicrosoftGraph
• FlatApi::ClassAttachmentCreation
• FlatApi::ClassCreation
• FlatApi::ClassDetails
• FlatApi::ClassDetailsCanvas
• FlatApi::ClassDetailsClever
• FlatApi::ClassDetailsGoogleClassroom
• FlatApi::ClassDetailsGoogleDrive
• FlatApi::ClassDetailsIssues
• FlatApi::ClassDetailsIssuesSyncInner
• FlatApi::ClassDetailsLti
• FlatApi::ClassDetailsMfc
• FlatApi::ClassDetailsMicrosoftGraph
• FlatApi::ClassGradeLevel
• FlatApi::ClassRoles
• FlatApi::ClassState
• FlatApi::ClassUpdate
• FlatApi::Collection
• FlatApi::CollectionApp
• FlatApi::CollectionCapabilities
• FlatApi::CollectionCreation
• FlatApi::CollectionModification
• FlatApi::CollectionPrivacy
• FlatApi::CollectionType
• FlatApi::EduLibrary
• FlatApi::EduResource
• FlatApi::EduResourceCapabilities
• FlatApi::EduResourceCopy
• FlatApi::EduResourceCreation
• FlatApi::EduResourceFolder
• FlatApi::EduResourceLtiLink
• FlatApi::EduResourceMove
• FlatApi::EduResourcePrivacy
• FlatApi::EduResourceResource
• FlatApi::EduResourceType
• FlatApi::EduResourceUpdate
• FlatApi::EduResourceUseInClass
• 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::MicrosoftGraphAssignment
• FlatApi::MicrosoftGraphSubmission
• FlatApi::OrganizationInvitation
• FlatApi::OrganizationInvitationCreation
• FlatApi::OrganizationRoles
• FlatApi::OrganizationUserAccessTokenCreation
• FlatApi::ResourceCollaborator
• FlatApi::ResourceCollaboratorCreation
• FlatApi::ResourceRights
• FlatApi::ScoreComment
• FlatApi::ScoreCommentContext
• FlatApi::ScoreCommentCreation
• FlatApi::ScoreCommentModeration
• FlatApi::ScoreCommentUpdate
• FlatApi::ScoreCommentsCounts
• FlatApi::ScoreCreation
• FlatApi::ScoreCreationBuilderData
• FlatApi::ScoreCreationBuilderDataAllOfBuilderData
• FlatApi::ScoreCreationBuilderDataAllOfBuilderDataLayoutData
• FlatApi::ScoreCreationBuilderDataAllOfBuilderDataScoreData
• FlatApi::ScoreCreationBuilderDataAllOfBuilderDataScoreDataInstruments
• FlatApi::ScoreCreationCommon
• FlatApi::ScoreCreationFileImport
• FlatApi::ScoreCreationGoogleDriveImport
• FlatApi::ScoreCreationType
• FlatApi::ScoreDetails
• FlatApi::ScoreFork
• FlatApi::ScoreLicense
• FlatApi::ScoreLikesCounts
• FlatApi::ScoreModification
• FlatApi::ScorePlaysCounts
• FlatApi::ScorePrivacy
• FlatApi::ScoreRevision
• FlatApi::ScoreRevisionCreation
• FlatApi::ScoreRevisionStatistics
• FlatApi::ScoreSource
• FlatApi::ScoreSummary
• FlatApi::ScoreTrack
• FlatApi::ScoreTrackCreation
• FlatApi::ScoreTrackPoint
• FlatApi::ScoreTrackPurpose
• FlatApi::ScoreTrackState
• FlatApi::ScoreTrackType
• FlatApi::ScoreTrackUpdate
• FlatApi::ScoreViewsCounts
• FlatApi::Task
• FlatApi::TaskExportOptions
• FlatApi::TaskProgress
• FlatApi::TaskResult
• FlatApi::TutteoProduct
• FlatApi::UserAdminUpdate
• FlatApi::UserAzureDetails
• FlatApi::UserBasics
• FlatApi::UserCommunityProfileLinks
• FlatApi::UserCreation
• FlatApi::UserDetails
• FlatApi::UserDetailsAdmin
• FlatApi::UserDetailsAdminAllOfLicense
• FlatApi::UserPublic
• FlatApi::UserPublicSummary
• FlatApi::UserSigninLink
• FlatApi::UserSigninLinkCreation

Authentication schemes defined for the API:

• 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.email: Provices access to the person's email.
  • 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.resources: Read-write access to the resource library.
  • edu.resources.readonly: Read-only access to the resource library.
  • 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.
  • tasks.readonly: Read-only access to export tasks created by this account.