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 interoduction * Authentication (Personal Access Tokens or OAuth2) * SDKs * Rate Limits * Changelog

This Python package is automatically generated by the OpenAPI Generator project:

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

Python 2.7 and 3.4+

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import flat_api

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import flat_api

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import flat_api
from flat_api.rest import ApiException
from pprint import pprint

configuration = flat_api.Configuration()
# Configure OAuth2 access token for authorization: OAuth2
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Defining host is optional and default to https://api.flat.io/v2
configuration.host = "https://api.flat.io/v2"
# Create an instance of the API class
api_instance = flat_api.AccountApi(flat_api.ApiClient(configuration))

try:
    # Get current user profile
    api_response = api_instance.get_authenticated_user()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountApi->get_authenticated_user: %s\n" % e)

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

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

• 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.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.

[email protected]