STADATA Flutter SDK - Simplified Access to WebAPI BPS #

Description #

The STADATA Flutter SDK is a powerful and user-friendly Flutter SDK designed to seamlessly integrate with the official API offered by the Badan Pusat Statistik (BPS) Statistic of the Republic of Indonesia. BPS offers a WebAPI - https://webapi.bps.go.id/developer/ that allows users to programmatically access various types of data, including Publications, Press Releases, static tables, and dynamic tables.

This SDK empowers Flutter developers to effortlessly access a wealth of statistical data and information directly from BPS's extensive database, enabling the creation of data-driven applications that provide valuable insights into various aspects of Indonesia's socio-economic landscape.

With STADATA Flutter SDK, you can harness the comprehensive data sets made available by BPS, covering a wide range of domains such as population, economy, demographics, and more. This SDK simplifies the process of fetching, processing, and presenting statistical data within your Flutter apps, ensuring a smooth and efficient user experience by eliminate the need for manual data downloads from the https://www.bps.go.id/.

Key Features #

• Seamless Integration: Easily incorporate BPS Statistic of the Republic of Indonesia's data into your Flutter projects.
• Rich Data Sources: Access a vast repository of statistical data on Indonesia's diverse economic and demographic aspects.
• User-Friendly: Designed with developers in mind, making it straightforward to utilize the API's functionalities.
• Data Insights: Create data-driven applications to provide valuable insights and visualizations to your users.
• Up-to-Date: Stay current with the latest data releases and updates from BPS.

Unlock the potential of BPS's statistical data with the stadata_flutter_sdk and empower your Flutter applications to provide users with valuable information and insights about Indonesia's dynamic landscape.

For detailed usage instructions and documentation of the BPS API, please refer to the official documentation.

Table Of Contents #

• STADATA Flutter SDK - Simplified Access to WebAPI BPS
  • Description
  • Key Features
  • Table Of Contents
  • Getting Started
  • Try the Example
  • Usage
    • List
    • View
    • Enums for Simplified API Requests and Response Handling
  • List API
    • Domains
      • Parameters
      • Properties (DomainEntity)
    • Publications
      • Parameters
      • Properties (Publication)
    • Infographics
      • Parameters
      • Properties (Infographic)
  • View API
    • Publication Detail
      • Parameters
      • Properties (Publication)
  • To-Do
    • List API TODO
    • View API TODO
  • Running Tests

Getting Started #

Follow these steps to quickly integrate the Stadata Flutter SDK into your Flutter project.

• Update Your Dependency:

  First, ensure that your stadata_flutter_sdk dependency is up-to-date by including the latest version in your pubspec.yaml file. You can check the latest available version on pub.flutter-io.cn.

  dependencies:
    stadata_flutter_sdk: ^latest_version
  

  Replace ^latest_version with the actual latest version number.

• Install Dependencies:

  After updating your pubspec.yaml, run the following command to fetch and install the SDK package:

  flutter pub get
  

  You can also install it from the cli by using this command

  flutter pub add stadata_flutter_sdk
  

• Initialize the SDK:

  Initialize the Stadata Flutter SDK in your main.dart file and make sure to include your API token. Replace 'YOUR_API_KEY' with your actual API key obtained from the Stadata API.

  import 'package:flutter/material.dart';
  import 'package:stadata_flutter_sdk/stadata_flutter_sdk.dart';
  
  void main() async {
    // Ensure Flutter is initialized
    WidgetsFlutterBinding.ensureInitialized();
  
    // Initialize the StadataFlutter instance with your API key
    await StadataFlutter.instance.init(
      apiKey: 'YOUR_API_KEY',
    );
  
    // Your app's entry point
    runApp(MyApp());
  }
  

• Start Using Stadata Flutter SDK:

  With the SDK initialized, you're ready to start using the Stadata API within your Flutter app. Refer to the SDK's documentation and examples to learn how to retrieve data and integrate it into your application.

  // Example: Fetching data using the SDK
  final response = await StadataFlutter.instance.list.domains();
  // Handle the response and update your app's UI as needed.
  

That's it! You've successfully integrated the Stadata Flutter SDK into your project. You can now start utilizing the data and features provided by Stadata in your Flutter app.

Now, you're ready to explore the capabilities of the STADATA Flutter SDK in your Flutter application.

Try the Example #

You can explore the capabilities of the Stadata Flutter SDK by checking out the example app provided in the SDK's GitHub repository.

To run the example app and see the SDK in action, follow these steps:

1. Create an .env file in the example directory or copy it from .env.example:

   cp .env.example .env
   

2. Copy your API_KEY to the .env file:

   API_KEY=  # Put your API Key here
   

3. Generate env.g.dart by running the following command in the example directory:

   dart run build_runner build -d
   

   If the build is successful, it will generate the necessary code.

4. Run the example app:

   flutter run
   

Now, you're ready to explore the capabilities of the Stadata Flutter SDK in your Flutter application using the example provided. This example will help you understand how to integrate and use the SDK effectively in your own projects.

Usage #

The BPS Web API provides two main types of data: "list" and "view." Each type serves different purposes, and here's a guide on how to use them.

List #

The list method returns a ListResult class, which includes two main properties:

1. Data Property:
   • The data property contains a list of data based on the specified type. For instance, if you are fetching publications, the data will be of type List<Publication>.
2. Pagination Property:
   • The pagination property is an instance of the Pagination entity, which provides information related to pagination. It includes the following properties:
     • page: The current page.
     • pages: The total number of pages.
     • count: The count of data entries on the current page.
     • perPage: The number of entries per page.
     • total: The total number of data entries.

To retrieve a list of models, follow these steps:

1. Create an instance of StadataFlutter.

2. Access the list getter from the instance, granting you access to various models from domains, publications, press releases, and more.

3. Use the list method with the desired parameters. For example:

var result = await StadataFlutter.instance.list.publications(domain: '7200');

This call will provide you with a ListResult containing data of type List<Publication> and pagination information for further navigation.

View #

In addition to the list property, StadataFlutter also provides the view property, which allows you to retrieve detailed information about a specific model. For instance, if you want to view the details of a publication, follow these steps:

1. Create an Instance of StadataFlutter:

   • Begin by creating an instance of StadataFlutter.

2. Access the view Getter:

   • Access the view getter from the instance, granting you access to different models from domains, publications, press releases, and more.

3. Use the view Method with Required Parameters:

   • Utilize the view method, specifying the required parameters. For example:

var result = await StadataFlutter.instance.view.publication(
  id: 'a78f4d4f1c3548600cffcd29',
  domain: '7200'
);

By following these steps, you can seamlessly retrieve detailed information about specific models using the BPS Web API. Whether you need to access lists or in-depth details, StadataFlutter provides the tools to help you accomplish your goals efficiently.

Enums for Simplified API Requests and Response Handling #

Within the StadataFlutter SDK, you'll find several enums designed to streamline API requests and facilitate the handling of API responses.

1. DataLanguage Enum:

• The DataLanguage enum is used to specify the language (lang) parameter when making API requests. It offers two options:

  Enums	Param Value	Description	Status
  DataLanguage.id	ind	Represents the Indonesian language.	Default
  DataLanguage.en	eng	Represents the English language.

2. DomainType Enum:

• The DomainType enum simplifies domain type (type) parameters for Domain models in API requests. It includes the following options:

  Enums	Actual Value	Description	Status
  DomainType.all	all	Retrieve all domains, including provinces and regencies.	Default
  DomainType.province	prov	Retrieve all province domains.
  DataLanguage.regency	kab	Retrieve all regency domains.
  DataLanguage.regencyByProvince	kabbyprov	Retrieve all regency domains within a specified province ID.

3. DataAvailability Enum:

• The DataAvailability enum helps you check the data-availability key in API responses, making it easier to determine the availability of data. It includes the following options:

  Enums	Actual Value	Description
  DataAvailability.available	available	Indicates that data is available.
  DataAvailability.listNotAvailable	list-not-available	Indicates that the list is not available.
  DataAvailability.notAvailable	not-available	Indicates that data is not available.

These enums serve as valuable tools to enhance the readability and manageability of your API-related code. Whether you're specifying language preferences, domain types, or checking data availability, these enums simplify the process and make your code more concise and expressive.

List API #

The List API provides convenient methods for retrieving lists of data resources from the BPS API based on the type of data needed. To use the List API, you can access it using the following code:

final list = StadataFlutter.instance.list;

Several types of data are available, including:

Domains #

This method is used to retrieve a list of domains (regions) available in the BPS data.

Parameters

Example usage and sample output:

// Fetch domain data from BPS API
final domainResult = await StadataFlutter.instance.list.domains(
  type: DomainType.all,
  provinceCode: null, // Replace with the desired province code if needed
);

final domainList = domainResult.data;
final pagination = domainResult.pagination;

// Print pagination info
print('Current Page: ${pagination.page}');
print('Total Pages: ${pagination.pages}');
print('Data Count in This Page: ${pagination.count}');
print('Per Page: ${pagination.perPage}');
print('Total: ${pagination.total}');
print('------------------------');

// Print the retrieved domain data
for (final domain in domainList) {
  print('Domain ID: ${domain.id}'); /// Ex. 7200
  print('Name: ${domain.name}'); /// Sulawesi Tengah
  print('URL: ${domain.url}'); /// https://sultengprov.bps.go.id
  print('------------------------');
}

Properties (DomainEntity)

Publications #

This method is used to retrieve a list of publications based on the selected domain (region).

Parameters

Example usage and sample output:

// Fetch publication data from BPS API
final publicationResult = await StadataFlutter.instance.list.publications(
  domain: 'example_domain_code', // Replace with the desired domain code
  lang: DataLanguage.id,
  page: 1,
  keyword: 'example_keyword', // Replace with desired keyword or null
  month: null, // Replace with desired month or null
  year: null, // Replace with desired year or null
);

final publicationList = publicationResult.data;
final pagination = publicationResult.pagination;

// Print pagination info
print('Current Page: ${pagination.page}');
print('Total Pages: ${pagination.pages}');
print('Data Count in This Page: ${pagination.count}');
print('Per Page: ${pagination.perPage}');
print('Total: ${pagination.total}');
print('------------------------');

// Print the retrieved publication data
for (final publication in publicationList) {
  print('Publication ID: ${publication.id}');
  print('Title: ${publication.title}');
  print('ISSN: ${publication.issn}');
  print('Scheduled Date: ${publication.scheduledDate}');
  print('Release Date: ${publication.releaseDate}');
  print('Update Date: ${publication.updateDate}');
  print('Cover Image URL: ${publication.cover}');
  print('PDF File URL: ${publication.pdf}');
  print('Size: ${publication.size}');
  print('Abstract: ${publication.abstract ?? 'Not available'}');
  print('Catalogue Number: ${publication.catalogueNumber ?? 'Not available'}');
  print('Publication Number: ${publication.publicationNumber ?? 'Not available'}');
  print('------------------------');
}

Properties (Publication)

Infographics #

This method is used to retrieve a list of infographics based on the selected domain (region).

Parameters

Example usage and sample output:

// Fetch infographic data from BPS API
final infographicResult = await StadataFlutter.instance.list.infographics(
  domain: 'example_domain_code', // Replace with the desired domain code
  lang: DataLanguage.id,
  page: 1,
  keyword: 'example_keyword', // Replace with desired keyword or null
);

final infographicList = infographicResult.data;
final pagination = infographicResult.pagination;

// Print pagination info
print('Current Page: ${pagination.page}');
print('Total Pages: ${pagination.pages}');
print('Data Count in This Page: ${pagination.count}');
print('Per Page: ${pagination.perPage}');
print('Total: ${pagination.total}');
print('------------------------');

// Print the retrieved infographic data
for (final infographic in infographicList) {
  print('Infographic ID: ${infographic.id}');
  print('Title: ${infographic.title}');
  print('Image URL: ${infographic.image}');
  print('Description: ${infographic.description}');
  print('Category: ${infographic

Properties (Infographic)

You can use these methods and properties to retrieve and work with data resources from the BPS API.

View API #

The View API provides methods for retrieving detailed information about specific models from the BPS API. To use the View API, you can access it using the following code:

final view = StadataFlutter.instance.view;

Several model types are available, each with its own set of properties. Below, you'll find documentation for the available model types and their respective methods.

Publication Detail #

This method is used to retrieve detailed information about a specific publication.

Parameters

Example usage and sample output:

// Fetch publication detail from BPS API
final publication = await StadataFlutter.instance.view.publication(
  id: 'example_publication_id', // Replace with the desired publication ID
  domain: 'example_domain', // Replace with the desired Domain Code
  lang: DataLanguage.id,
);

  print('Publication ID: ${publication.id}');
  print('Title: ${publication.title}');
  print('ISSN: ${publication.issn}');
  print('Scheduled Date: ${publication.scheduledDate}');
  print('Release Date: ${publication.releaseDate}');
  print('Update Date: ${publication.updateDate}');
  print('Cover Image URL: ${publication.cover}');
  print('PDF File URL: ${publication.pdf}');
  print('Size: ${publication.size}');
  print('Abstract: ${publication.abstract ?? 'Not available'}');
  print('Catalogue Number: ${publication.catalogueNumber ?? 'Not available'}');
  print('Publication Number: ${publication.publicationNumber ?? 'Not available'}');

Properties (Publication)

To-Do #

List API TODO #

• ✅ Domains
• ✅ Publications
• ✅ Infographics
• ❌ Static Table
• ❌ Dynamic Table
• ❌ Press Release
• ❌ News
• ❌ KBLI

View API TODO #

• ✅ Publication
• ❌ Static Table
• ❌ Dynamic Table
• ❌ Press Release
• ❌ News
• ❌ KBLI

Running Tests #

For first time users, install the very_good_cli:

dart pub global activate very_good_cli

To run all unit tests:

very_good test --coverage

To view the generated coverage report you can use lcov.

# Generate Coverage Report
genhtml coverage/lcov.info -o coverage/

# Open Coverage Report
open coverage/index.html