https://github.com/pluggyai/pluggy-java
Official Java SDK for Pluggy API
https://github.com/pluggyai/pluggy-java
banking open open-banking pluggy pluggy-api pluggy-sdk
Last synced: 5 months ago
JSON representation
Official Java SDK for Pluggy API
- Host: GitHub
- URL: https://github.com/pluggyai/pluggy-java
- Owner: pluggyai
- Created: 2020-07-29T16:46:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-11-06T21:57:10.000Z (7 months ago)
- Last Synced: 2025-11-06T23:29:05.570Z (7 months ago)
- Topics: banking, open, open-banking, pluggy, pluggy-api, pluggy-sdk
- Language: Java
- Homepage: https://docs.pluggy.ai
- Size: 262 KB
- Stars: 7
- Watchers: 2
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Pluggy Java
[](https://github.com/pluggyai/pluggy-java/actions?query=workflow%3A"Build+%26+Test")
Java Bindings for the Pluggy API (https://docs.pluggy.ai/).
For available SDK API methods, check [PluggyApiService](./src/main/java/ai/pluggy/client/PluggyApiService.java) interface methods.
This implementation uses [Retrofit](https://github.com/square/retrofit) and [OkHttp](https://github.com/square/okhttp) libraries. For advanced use cases, please check their respectives APIs.
Also, for examples of use, please check the [integration tests](./src/test/java/ai/pluggy/client/integration) - practically all of the available endpoints have at least one test case.
### Install
Using Maven, add dependency to your pom.xml:
Currently, the package is available in Github Packages, so make sure to have the GH Packages server config with your Personal GH Access Token in your `.m2/settings.xml` file. Navigate to [this guide](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages#authenticating-to-github-packages) for more details.
```xml
ai.pluggy
pluggy-java
1.7.0
```
### Basic Usage
```java
// Use builder to create a client instance
PluggyClient pluggyClient = PluggyClient.builder()
.clientIdAndSecret("your_client_id", "your_secret")
.build();
// Authenticate your client (optional - by default, auth token is requested & refreshed as needed by ApiKeyAuthInterceptor)
pluggyClient.authenticate()
// Synchronously perform a request
Response connectorsResponse = pluggyClient.service().getConnectors().execute();
// or, a request with params:
Response connectorsResponseFiltered = pluggyClient.service()
.getConnectors(new ConnectorSearchRequest("Pluggy", Arrays.asList("AR")))
.execute();
// Read response data (or error):
if(connectorsResponse.isSuccessful()) {
// successful -> get body
ConnectorsResponse connectorsResponseBody = connectorsResponse.body();
} else {
// unsuccessful -> parse error data
ErrorResponse errorResponse = pluggyClient.parseError(connectorsResponse)
}
```