Ballerina Central will undergo scheduled maintenance on Wednesday, August 06, from 00:30 AM to 01:30 AM UTC. During this time, Ballerina Central login and sign up will be temporarily disabled. We appreciate your patience as we work to improve your experience. For more information, reach out to contact@ballerina.io

Module flatapi

ballerinax/flatapi Ballerina library

1.5.1

Overview

This is a generated connector for Flat API v2.13.0 OpenAPI specification. The Flat API allows you to easily extend the abilities of the Flat Platform. Flat is a powerful cloud-based notation software that let you to create music scores and guitar tabs.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Flat connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

Import the ballerinax/flatapi module into the Ballerina project.

Copy
import ballerinax/flatapi;

Step 2: Create a new connector instance

You can use Personal Access Token(PAT) for authentication:

Copy
flatapi:ClientConfig clientConfig = {
    auth: {
        token: <PAT_TOKEN>
    }
};

flatapi:Client baseClient = check new Client(clientConfig, serviceUrl = "https://api.flat.io/v2");

Step 3: Invoke connector operation

  1. You can get detail about score created.
    Copy
    flatapi:ScoreDetails score = check baseClient->getScore(<SCORE_ID>);
  2. Use bal run command to compile and run the Ballerina program.

Import

import ballerinax/flatapi;Copy

Other versions

See more...

Metadata

Released date: about 2 years ago

Version: 1.5.1

License: Apache-2.0


Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes


Pull count

Total: 5

Current verison: 5


Weekly downloads


Source repository


Keywords

Lifestyle & Entertainment/News & Lifestyle

Cost/Freemium


Contributors