README.md

Pixivj

A java client for Pixiv.

Pixiv API doc

Currently, only a small subset of the APIs are implemented. If you want to use an API that isn't yet supported, please leave an issue or directly send a PR.

Usage

Getting Started

Add dependency to your project.

<dependency>
  <groupId>com.github.hanshsieh</groupId>
  <artifactId>pixivj</artifactId>
  <version>1.2.3</version>
</dependency>
<dependency>
  <groupId>com.github.hanshsieh</groupId>
  <artifactId>pixivjjfx</artifactId>
  <version>0.1.4-beta</version>
</dependency>

Checkout pixivj and pixivjjfx for latest available versions.
If you want to try out snapshot versions, see here for the available versions.
You can allow your project to pull snapshot versions by adding the following profile to your pom.xml (for Maven)

<project>
    <profiles>
        <profile>
            <id>dev</id>
            <activation><activeByDefault>true</activeByDefault></activation>
            <repositories>
                <repository>
                    <id>snapshots-repo</id>
                    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
                    <releases><enabled>false</enabled></releases>
                    <snapshots><enabled>true</enabled></snapshots>
                </repository>
            </repositories>
        </profile>
    </profiles>
</project>

Here's a sample code:

import com.github.hanshsieh.pixivj.api.PixivApiClient;
import com.github.hanshsieh.pixivj.model.FilterType;
import com.github.hanshsieh.pixivj.model.SearchTarget;
import com.github.hanshsieh.pixivj.model.SearchedIllusts;
import com.github.hanshsieh.pixivj.model.SearchedIllustsFilter;
import com.github.hanshsieh.pixivj.oauth.PixivOAuthClient;
import com.github.hanshsieh.pixivj.token.ThreadedTokenRefresher;
import com.github.hanshsieh.pixivj.token.TokenRefresher;
import com.github.hanshsieh.pixivjjfx.stage.PixivLoginStage;
import java.io.Closeable;
import javafx.application.Application;
import javafx.stage.Stage;
public class Test extends Application {
  @Override
  public void start(Stage primaryStage) {
    // Simulate a worker thread
    new Thread(() -> {
      PixivOAuthClient authClient = null;
      TokenRefresher tokenRefresher = null;
      PixivLoginStage loginStage;
      try {
        authClient = new PixivOAuthClient.Builder().build();
        tokenRefresher = new ThreadedTokenRefresher.Builder()
            .setAuthClient(authClient)
            .build();
        loginStage = new PixivLoginStage.Builder().buildInFxThread();
        WebViewTokenProvider tokenProvider = new WebViewTokenProvider.Builder()
            .setAuthClient(authClient)
            .setTokenRefresher(tokenRefresher)
            .setLoginStage(loginStage)
            .build();
        PixivApiClient client = new PixivApiClient.Builder()
            .setTokenProvider(tokenProvider)
            .build();
        SearchedIllustsFilter searchIllustFilter = new SearchedIllustsFilter();
        searchIllustFilter.setFilter(FilterType.FOR_ANDROID);
        searchIllustFilter.setIncludeTranslatedTagResults(true);
        searchIllustFilter.setMergePlainKeywordResults(true);
        searchIllustFilter.setOffset(0);
        searchIllustFilter.setSearchTarget(SearchTarget.PARTIAL_MATCH_FOR_TAGS);
        searchIllustFilter.setWord("swimsuit");
        SearchedIllusts searchedIllusts = client.searchIllusts(searchIllustFilter);
        System.out.println(searchedIllusts);
      } catch (Exception ex) {
        ex.printStackTrace();
      } finally {
        closeQuietly(authClient);
        closeQuietly(tokenRefresher);
      }
    }).start();
  }

  private static void closeQuietly(Closeable closeable) {
    if (closeable == null) {
      return;
    }
    try {
      closeable.close();
    } catch (Exception ex) {
      // Do nothing
    }
  }

  public static void main(String[] args) {
    launch();
  }
}

com.github.hanshsieh.pixivj.api.PixivApiClient requires an implementation of com.github.hanshsieh.pixivj.token.TokenProvider to obtain an access token, which is required to access the Pixiv API. Here, com.github.hanshsieh.pixivjjfx.token.WebViewTokenProvider is used. It displays a web view using JavaFX, lets the user login, and obtains an access token and a refresh token. The tokens are then fed into com.github.hanshsieh.pixivj.token.ThreadedTokenRefresher, which automatically refreshes the access token using the refresh token in the background.
Notice that WebViewTokenProvider is provided by another artifact pixivjjfx.

Since 2021/02/08, Pixiv no longer supports logging in with username/password by calling its RESTful API. To login, user must login via its web interface.

Then, you can compile your project with

mvn package

The example here depends on JavaFX. If you don't want to use JavaFX, and you are able to get an access token using another way, you can directly use com.github.hanshsieh.pixivj.token.ThreadedTokenRefresher , and remove the dependency on JavaFX.

Authentication

Pixiv has two set of RESTful APIs.
One is under the URL https://app-api.pixiv.net. It's used, for example, getting illustrations. Most of the time, you will use the APIs under this URL. It's implemented by com.github.hanshsieh.pixivj.api.PixivApiClient.
Another one is under the URL https://oauth.secure.pixiv.net. It's used for doing authentication. It's implemented by com.github.hanshsieh.pixivj.api.PixivOAuthClient.
After authentication is completed, you can obtain two tokens:

• Access token A short-lived token. You need this token when calling the APIs under https://app-api.pixiv.net.
• Refresh token Its lifetime is longer. You can use this token to get a new access token and refresh token.

Refreshing Access Token

If you have a refresh token you can use it to refresh the access token.
There're some implementations that help you refresh the access tokens. Checkout the classes that implements com.github.hanshsieh.pixivj.token.TokenRefresher.
For example, com.github.hanshsieh.pixivj.token.ThreadedTokenRefresher will refresh the access token periodically in a background thread.

Contribution

Style

Please follow the Google coding style.
You may apply the IntelliJ style file here.

Release

Follow the guide at here to setup your PGP key and settings.xml.
Update the version in pom.xml appropriately.
Then, run

mvn -Duser.name="$(git config --get user.name)" clean deploy -P release