movabletype/mt-data-api-sdk-java

Movable Type Data API SDK for Java

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.movabletype:mt-data-api-sdk-java:0.0.5'
	}
	dependencies {
		implementation("com.github.movabletype:mt-data-api-sdk-java:0.0.5")
	}
	<dependency>
	    <groupId>com.github.movabletype</groupId>
	    <artifactId>mt-data-api-sdk-java</artifactId>
	    <version>0.0.5</version>
	</dependency>

                            
    libraryDependencies += "com.github.movabletype" % "mt-data-api-sdk-java" % "0.0.5"
        
        

                            
    :dependencies [[com.github.movabletype/mt-data-api-sdk-java "0.0.5"]]

Readme

Movable Type Data API SDK for Java

Requirements

Java 6 or later

Some Examples

Usage Example

// Initialize API client.
String username = "melody";   // Your Sign-in Name
String password = "nelson";   // Your web service password
String clientId = "JavaClient";
String endpoint = "http://localhost/mt/mt-data-api.cgi";
MovableTypeApiClient client = MovableTypeClientFactory.createDataApiClient(username, password, clientId, endpoint);

// Call createEntry endpoint.
int siteId = 1;
Entry entry = new Entry();
entry.setTitle("Title");
entry.setBody("Body");
entry.setStatus(EntryStatus.PUBLISH);
Entry postEntry = client.postEntry(siteId, entry);

Creating a API Client

// Api Authentication
MovableTypeApiClient client
    = MovableTypeClientFactory.createDataApiClient(username,password,clientId,endpoint);

// Api Authentication + Basic Authentication
MovableTypeApiClient client
    = MovableTypeClientFactory.createDataApiClient(username,password,clientId,endpoint,basicAuthId,basicAuthPass);

// Not authentication
MovableTypeApiClient client
    = MovableTypeClientFactory.createDataApiClient(clientId,endpoint);

Site

// Create a new website.
Site site = new Site();
site.setName("WebSite");
site.setUrl("http://example.com/");
site.setSitePath("/data/file/static/example.com");
site = client.createWebsite(site);
System.out.println(site.getId());
System.out.println(site.getHost());

// Create a new blog under the site.
int site_id = 4;
Site site = new Site();
site.setName("Blog");
site.setUrl("http://example.com/blog/");
site.setSitePath("/data/file/static/example.com/blog");
site = client.createBlog( site_id, site) ;
System.out.println(site.getId());
System.out.println(client.getResponseMessage());

// Retrieve a list of sites.
SiteSearchParam siteSearchParam = new SiteSearchParam();
siteSearchParam.setSearch("Blog");
SiteItems siteItems = client.searchSite(siteSearchParam);
siteItems.getItems();
for (Site site : siteItems.getItems()) {
   System.out.println(site.getId());
   System.out.println(site.getName());
}

// Retrieve a list of sites by user.
SiteSearchParam siteSearchParam = new SiteSearchParam();
siteSearchParam.setUser_id("me");   // number or 'me' The user ID or the word ‘me’.
SiteItems siteItems = client.searchSite(siteSearchParam);
siteItems.getItems();
for (Site site : siteItems.getItems()) {
   System.out.println(site.getId());
}

// Retrieve a list of sites by parent site
SiteSearchParam siteSearchParam = new SiteSearchParam();
siteSearchParam.setSite_id(1);
SiteItems siteItems = client.searchSite(siteSearchParam);
siteItems.getItems();
for (Site site : siteItems.getItems()) {
   System.out.println(site.getId());
}

// Retrieve a single website/blog by its ID.
int site_id = 4;
String fields = "id,name";  // All fields is null
Site site = client.getSite(site_id, fields);
System.out.println(site.getId());
System.out.println(site.getName());

// Update an existing site.
site.setName("Update WebSite");
site = client.updateSite(site);
System.out.println(site.getName());

// Update an existing Blog.
site.setName("Update Blog");
site = client.updateBlog(site);
System.out.println(site.getName());

// Delete an existing site.
Site site = client.deleteSite(site_id);
System.out.println(client.getResponseMessage());

Entry

// Create a new entry.
int site_id = 2;
Entry entry = new Entry();
entry.setTitle("Title");
entry.setBody("Body");
entry.setStatus(EntryStatus.PUBLISH);
entry = client.postEntry(site_id, entry);
System.out.println(entry.getId());
System.out.println(entry.getCreatedDate());

// Searching the entries.
EntrySearchParam search = new EntrySearchParam();
search.setSite_id(2);
search.setLimit(2);
search.setSearch("Title");
EntryItems entryItems = client.searchEntry(search);
for (Entry entry : entryItems.getItems()) {
    System.out.println(entry.getId());
    System.out.println(entry.getTitle());
}

// Retrieve a list of entries by category.
EntrySearchParam search = new EntrySearchParam();
search.setSite_id(2);
search.setCategory_id(5);
EntryItems entryItems = client.searchEntry(search);
for (Entry entry : entryItems.getItems()) {
    System.out.println(entry.getId());
}

// Retrieve a list of entries that with asset.
EntrySearchParam search = new EntrySearchParam();
search.setSite_id(2);
search.setAsset_id(5);
EntryItems entryItems = client.searchEntry(search);
for (Entry entry : entryItems.getItems()) {
    System.out.println(entry.getId());
}

// Searching the entries that with tag.
EntrySearchParam search = new EntrySearchParam();
search.setSite_id(2);
search.setTag_id(5);
EntryItems entryItems = client.searchEntry(search);
for (Entry entry : entryItems.getItems()) {
    System.out.println(entry.getId());
}

// Retrieve a single entry by its ID.
EntrySearchParam search = new EntrySearchParam();
search.setSite_id(2);
search.setEntry_id(10);
search.setMaxComments(0);        // Maximum number of comments
search.setMaxTrackbacks(0);      // Maximum number of received trackbacks
search.setFields("title,body");  // All fields is null
Entry entry = client.getEntry(search);
System.out.println(entry.getId());
System.out.println(entry.getTitle());
System.out.println(entry.getBody());

// Update an existing category.
int site_id = 2;
entry.setTitle("Update Title");
entry = client.updateEntry(site_id, entry);
System.out.println(entry.getTitle());

// Delete an entry.
entry = client.deleteEntry(site_id, entry_id);
System.out.println(client.getResponseMessage());

Search

// Searching the entries.
// This endpoint is like a mt-search.cgi, but more faster.
SearchParam search = new SearchParam();
search.setBlog_id(2);
search.setSearch("title:News");
search.setLimit(5);
search.setSearchMaxResults(5);
EntryItems entryItems = client.search(search);
for (Entry entry : entryItems.getItems()) {
    System.out.println(entry.getBlog().getId());
    System.out.println(entry.getId());
    System.out.println(entry.getTitle());
}

Asset

// Upload a single file.
UploadParam uploadParam = new UploadParam();
uploadParam.setSite_id(1);
uploadParam.setUploadPath("/");
uploadParam.setAutoRenameIfExists(true);
uploadParam.setUploadLocalfile("/tmp/example.jpg");
Asset asset = client.uploadAsset(uploadParam);
System.out.println(asset.getFilename());
System.out.println(asset.getId());
System.out.println(client.getResponseMessage());

// Retrieve list of assets in the specified site.
AssetSearchParam assetSearchParam = new AssetSearchParam();
assetSearchParam.setSite_id(1);
assetSearchParam.setSearch("melody");
assetSearchParam.setSearchFields("label");
AssetItems assteItems = client.searchAsset(assetSearchParam);
for (Asset asset : assteItems.getItems()) {
    System.out.println(asset.getId());
    System.out.println(asset.getUrl());
}

// Retrieve list of assets that related with entry.
AssetSearchParam assetSearchParam = new AssetSearchParam();
assetSearchParam.setSite_id(1);
assetSearchParam.setEntry_id(2);
AssetItems assteItems = client.searchAsset(assetSearchParam);
for (Asset asset : assteItems.getItems()) {
    System.out.println(asset.getId());
}

// Retrieve list of assets that related with page.
AssetSearchParam assetSearchParam = new AssetSearchParam();
assetSearchParam.setSite_id(1);
assetSearchParam.setPage_id(5);
AssetItems assteItems = client.searchAsset(assetSearchParam);
for (Asset asset : assteItems.getItems()) {
    System.out.println(asset.getId());
}

// Retrieve list of assets that related with tag.
AssetSearchParam assetSearchParam = new AssetSearchParam();
assetSearchParam.setSite_id(1);
assetSearchParam.setTag_id(10);
AssetItems assteItems = client.searchAsset(assetSearchParam);
for (Asset asset : assteItems.getItems()) {
    System.out.println(asset.getId());
}

// Retrieve a single asset by its ID.
int site_id = 1;
int asset_id = 10;
String fields = "label,url";  // All fields is null
Asset asset = client.getAsset(site_id, asset_id, fields);
System.out.println(asset.getLabel());
System.out.println(asset.getUrl());

// Update an asset.
asset.setDescription("description-update.jpg");
asset.setLabel("label-update..jpg");
asset = client.updateAsset(site_id, asset);
System.out.println(asset.getLabel());
System.out.println(asset.getDescription());

// Delete an asset.
int site_id = 1;
int asset_id = 10;
Asset asset = client.deleteAsset(site_id, asset_id);
System.out.println(client.getResponseMessage());

Category

// Create a new category.
int site_id = 1;
Category category = new Category();
category.setBasename("news");
category.setLabel("News");
category.setClass_("category");
category = client.createCategory(site_id, category);
System.out.println(category.getId());

// Retrieve a list of categories.
CategorySearchParam categorySearchParam = new CategorySearchParam();
categorySearchParam.setSite_id(1);
categorySearchParam.setSearch("News");
categorySearchParam.setSearchFields("label");
CategoryItems categoryItems = client.searchCategory(categorySearchParam);
for (Category category : categoryItems.getItems()) {
    System.out.println(category.getLabel());
}

// Retrieve a list of categories that related with entry.
CategorySearchParam categorySearchParam = new CategorySearchParam();
categorySearchParam.setSite_id(1);
categorySearchParam.setEntry_id(2);
CategoryItems categoryItems = client.searchCategory(categorySearchParam);
for (Category category : categoryItems.getItems()) {
    System.out.println(category.getLabel());
}

// Retrieve a single category by its ID.
int site_id = 1;
int category_id = 1;
String fields = "id,basename"  // All fields is null
Category category = client.getCategory(site_id, category_id, fields);
System.out.println(category.getLabel());
System.out.println(category.getBasename());
System.out.println(category.getId());

// Update an existing category.
int site_id = 1;
category.setLabel("News2");
category = client.updateCategory(site_id, category);
System.out.println(category.getLabel());

// Delete an existing category.
int site_id = 1;
int category_id = 2;
Category category = client.deleteCategory(site_id, category_id);
System.out.println(client.getResponseMessage());

User

// Create a new user.
User createUser = new User();
createUser.setName("melody");
createUser.setPassword("nelsonnelson");
createUser.setDisplayName("Melody");
createUser.setEmail("melody@example.com");
User user = client.createUser(createUser);

// Retrieve a list of users.
UserSearchParam userSearchParam = new UserSearchParam();
userSearchParam.setSearch("melody");
userSearchParam.setSearchFields("email");
UserItems userItems = client.searchUser(userSearchParam);
for (User user : userItems.getItems()) {
    System.out.println(user.getId());
    System.out.println(user.getName());
    System.out.println(user.getEmail());
}

// Retrieve a single user by ID.
String user_id = "2";            // user_id or 'me'
String fields = "name,email";    // All fields is null
User user = client.getUser(user_id,fields);
System.out.println(user.getName());
System.out.println(user.getDisplayName());

// Update an existing user.
user.setDisplayName("melody2");
user = client.updateUser(user);
System.out.println(user.getDisplayName());

// Unlock user account.
int user_id = 2;
Status status = client.unlockUser(user_id);
System.out.println(status.getStatus());

// Delete an existing user.
User user = client.deleteUser(2);
System.out.println(client.getResponseMessage());

Session

// Sign out.
Status status =  client.signOut();
System.out.println(status.getStatus());

// Remove token.
Status status = client.deleteToken();
System.out.println(status.getStatus());

API Response

// HTTP status code.
int code = client.getResponseCode();

// API response message.
String message = client.getResponseMessage();

// API JSON Response.
String body = client.getResponseBody();

License

The MIT License (MIT)

Copyright

The following copyright notice applies to all the files provided in this distribution, including binary files, unless explicitly noted otherwise.

Copyright 2017 Six Apart, Ltd.