Skip to content
hizumiaoba edited this page Jun 8, 2023 · 3 revisions

Welcome to the HajimeAPI4J wiki! 日本語版はHajimeAPI4J ホームから

Welcome!

This wiki will describe you how to use HajimeAPI4J.

Please also refer to HajimeAPI's API Documentation!

Supported API Version

API Version Supported Wrapper version notice
v1 (v1.0.0, v2.0.7-Experimental) no bug reports or new feature requests are acceptable.
v2 [v3.0.0, v5.0.0.0-Alpha.1) Only bug reports can be acceptable.
v2.1 [v5.x.x.x) Bug reports and Security issues can be acceptable. It might take longer to implement new features to this version.
v3 [ v6.0.0.0-Alpha.1, ) All bug reports and new feature requests can be acceptable. Both v5 and v6 version can be used in general.

Code examples

All examples shown below and each builder descriptions are refered to the original API documentation.

/list Endpoint

Detailed description is here.

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/list?type=music

import hajimeapi4j.api.endpoint.ListEndPoint;  
import hajimeapi4j.internal.builder.ListEndPointBuilder;  
import hajimeapi4j.util.enums.ListParameter.Type;  
import java.util.List;  
import java.util.concurrent.CompletableFuture;  
  
class AllMusicList {  
  
  public static void main(String[] args) {  
	// generate builder instance from builder class
    ListEndPointBuilder builder = ListEndPointBuilder.createFor(Type.MUSIC);  

	// get response synchronizingly
    List<ListEndPoint> responseSync = builder.build().complete();  

	// output response
    responseSync.forEach(System.out::println);  

	// get response asynchronizingly
    CompletableFuture<List<ListEndPoint>> responseAsync = builder.build().submit();  

	// set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/list?type=music&search=器&limit=1

import hajimeapi4j.api.endpoint.ListEndPoint;  
import hajimeapi4j.internal.builder.ListEndPointBuilder;  
import hajimeapi4j.util.enums.ListParameter.Type;  
import java.util.List;  
import java.util.concurrent.CompletableFuture;  
  
class SearchMusicList {  
  
  public static void main(String[] args) {  
	// generate builder instance from builder class
    ListEndPointBuilder builder = ListEndPointBuilder.createFor(Type.MUSIC);  

	// set parameter informations
    builder  
        .setSearch("器") // search songs with '器'
        .setLimit(1); // only get 1 song

	// get response synchronizingly
    List<ListEndPoint> responseSync = builder.build().complete();  

	// output response
    responseSync.forEach(System.out::println);  
  
    // get response asynchronizingly
    CompletableFuture<List<ListEndPoint>> responseAsync = builder.build().submit();  
  
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/list?type=live&search=Funky Dancing

import hajimeapi4j.api.endpoint.ListEndPoint;  
import hajimeapi4j.internal.builder.ListEndPointBuilder;  
import hajimeapi4j.util.enums.ListParameter.Type;  
import java.util.List;  
import java.util.concurrent.CompletableFuture;  
  
class LiveWithSearchList {  
  
  public static void main(String[] args) {  
    // generate builder instance from builder class
    ListEndPointBuilder builder = ListEndPointBuilder.createFor(Type.LIVE);  
  
    // set parameter informations
    builder  
        .setSearch("Funky Dancing"); // search live informations with 'Funky Dancing'
  
    // get response synchronizingly
    List<ListEndPoint> responseSync = builder.build().complete();  
  
    // output response
    responseSync.forEach(System.out::println);  
  
    // get response asynchronizingly
    CompletableFuture<List<ListEndPoint>> responseAsync = builder.build().submit();  
  
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/list?type=idol&production=765

import hajimeapi4j.api.endpoint.ListEndPoint;  
import hajimeapi4j.internal.builder.ListEndPointBuilder;  
import hajimeapi4j.util.enums.ListParameter.Production;  
import hajimeapi4j.util.enums.ListParameter.Type;  
import java.util.List;  
import java.util.concurrent.CompletableFuture;  
  
class Scratch {  
  
  public static void main(String[] args) {  
    // generate builder instance from builder class
    ListEndPointBuilder builder = ListEndPointBuilder.createFor(Type.IDOL);  
  
    // set parameter informations
    builder  
        .setProduction(Production.NAMCO_ALL_STARS); // get idol information with 765 production  
  
    // get response synchronizingly
    List<ListEndPoint> responseSync = builder.build().complete();  
  
    // output response
    responseSync.forEach(System.out::println);  
  
    // get response asynchronizingly
    CompletableFuture<List<ListEndPoint>> responseAsync = builder.build().submit();  
  
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

/tax Endpoint

Detailed description is here

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/tax?id=1665

import hajimeapi4j.api.endpoint.TaxEndPoint;  
import hajimeapi4j.internal.builder.TaxEndPointBuilder;  
import java.util.concurrent.CompletableFuture;  
  
class TaxWithId {  
  
  public static void main(String[] args) {  
    // generate builder instance from builder class
    TaxEndPointBuilder builder = TaxEndPointBuilder.createWithId(1665);  
  
   // get response synchronizingly
    TaxEndPoint responseSync = builder.build().complete();  
  
    // output response 
    System.out.println(responseSync);  
  
   // get response asynchronizingly
    CompletableFuture<TaxEndPoint> responseAsync = builder.build().submit();  
  
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/tax?idol_name=春日未来&music_type=joint,cg

import hajimeapi4j.api.endpoint.TaxEndPoint;  
import hajimeapi4j.internal.builder.TaxEndPointBuilder;  
import hajimeapi4j.util.enums.TaxParameter.MusicType;  
import java.util.concurrent.CompletableFuture;  
  
class TaxWithId {  
  
  public static void main(String[] args) {  
    // generate builder instance from builder class
    TaxEndPointBuilder builder = TaxEndPointBuilder.createWithIdolName("春日未来");  
  
    // set parameter informations
    builder  
        .setMusicType(MusicType.JOINT, MusicType.CINDERELLA_GIRLS); // get Joint and Cinderella song  
  
    // get response synchronizingly
    TaxEndPoint responseSync = builder.build().complete();  
  
    // output response
    System.out.println(responseSync);  
  
    // get response asynchronizingly
    CompletableFuture<TaxEndPoint> responseAsync = builder.build().submit();  
  
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

/music Endpoint

Detailed description is here

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/music?id=3525

import hajimeapi4j.api.endpoint.MusicEndPoint;  
import hajimeapi4j.internal.builder.MusicEndPointBuilder;  
import java.util.concurrent.CompletableFuture;  
  
class Scratch {  
  
  public static void main(String[] args) {  
    // generate builder instance from builder class
    MusicEndPointBuilder builder = MusicEndPointBuilder.createWith(3525);  
    
    // get response synchronizingly
    MusicEndPoint responseSync = builder.build().complete();  
    
    // output response
    System.out.println(responseSync);  
    
    // get response asynchronizingly
    CompletableFuture<MusicEndPoint> responseAsync = builder.build().submit();  
    
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

Example of official API documentation:https://api.fujiwarahaji.me/v2.1/music?id=2907&hide=cd-member,live-member

import hajimeapi4j.api.endpoint.MusicEndPoint;  
import hajimeapi4j.internal.builder.MusicEndPointBuilder;  
import hajimeapi4j.util.enums.MusicParameter.Hide;  
import java.util.concurrent.CompletableFuture;  
  
class Scratch {  
  
  public static void main(String[] args) {  
    // generate builder instance from builder class
    MusicEndPointBuilder builder = MusicEndPointBuilder.createWith(2907);  
    
    // set parameter informations
    builder.setHide(Hide.CD_MEMBER, Hide.LIVE_MEMBER); // hide cd member and live member  
    
    // get response synchronizingly
    MusicEndPoint responseSync = builder.build().complete();  
    
    // output response
    System.out.println(responseSync);  
    
    // get response asynchronizingly
    CompletableFuture<MusicEndPoint> responseAsync = builder.build().submit();  
    
    // set callback function
    responseAsync.thenAccept(System.out::println);  
  }  
}

About the Fujiwarahajime API

Copyright © デレマス・ミリマス・シャニマス楽曲DB ふじわらはじめ All Rights Reserved.

ふじわらはじめAPI is the API service for iDOL M@STER songs maintained by デレマス・ミリマス・シャニマス楽曲DB ふじわらはじめ

This API is licenced under Creative Commons License BY-NC 4.0

Creative Commons BY-NC