SDKs

Java SDK

Official Java client for the MUDBASE API (Maven / Gradle).

Installation

java
// Gradle
implementation 'dev.mudbase:mudbase-sdk:1.3.12'

// Maven (pom.xml)
<dependency>
  <groupId>dev.mudbase</groupId>
  <artifactId>mudbase-sdk</artifactId>
  <version>1.3.12</version>
</dependency>
// Gradle
implementation 'dev.mudbase:mudbase-sdk:1.3.12'

// Maven (pom.xml)
<dependency>
  <groupId>dev.mudbase</groupId>
  <artifactId>mudbase-sdk</artifactId>
  <version>1.3.12</version>
</dependency>

Quick Start

Configure the shared ApiClient plus the API classes you need - there is no unified client wrapper. Log in first and use the returned JWT as a bearer token; the client's setApiKey helper targets a header that project API keys do not use yet, so it will not authenticate requests:

java
import dev.mudbase.sdk.ApiClient;
import dev.mudbase.sdk.Configuration;
import dev.mudbase.sdk.api.AuthenticationApi;
import dev.mudbase.sdk.api.DataApi;
import dev.mudbase.sdk.model.LoginRequest;
import dev.mudbase.sdk.model.AuthResponse;
import dev.mudbase.sdk.model.DataListResponse;

ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://cloud.mudbase.dev");

AuthenticationApi auth = new AuthenticationApi(defaultClient);

// Log in an end-user of your project
AuthResponse session = auth.loginUser(new LoginRequest().email("morgan.chen@northwind.dev").password("hunter2"));

// Use the returned JWT for subsequent authenticated calls
defaultClient.setBearerToken(session.getToken());

DataApi data = new DataApi(defaultClient);

// List documents in a collection
DataListResponse items = data.listData(projectId, collectionId, 1, 20, "-createdAt", null);
import dev.mudbase.sdk.ApiClient;
import dev.mudbase.sdk.Configuration;
import dev.mudbase.sdk.api.AuthenticationApi;
import dev.mudbase.sdk.api.DataApi;
import dev.mudbase.sdk.model.LoginRequest;
import dev.mudbase.sdk.model.AuthResponse;
import dev.mudbase.sdk.model.DataListResponse;

ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://cloud.mudbase.dev");

AuthenticationApi auth = new AuthenticationApi(defaultClient);

// Log in an end-user of your project
AuthResponse session = auth.loginUser(new LoginRequest().email("morgan.chen@northwind.dev").password("hunter2"));

// Use the returned JWT for subsequent authenticated calls
defaultClient.setBearerToken(session.getToken());

DataApi data = new DataApi(defaultClient);

// List documents in a collection
DataListResponse items = data.listData(projectId, collectionId, 1, 20, "-createdAt", null);

More

For error handling, pagination, and other languages, see the SDKs Overview.

Chat with us