kallasoft SmugMug API Manual

Table of Contents

Introduction

Notes

This section provide quick tidbits of information about the Kallasoft SmugMug REST API.

Unit Tests

The kallasoft SmugMug REST API provides a full suite of JUnit test cases for
each of the API methods implemented. Because the API requires sensitive information
in order to run (e.g. login information, user IDs, etc.) all of that information
has been collected in a single properties file and placed at the root of the
classpath during development. This file cannot be shipped outside of the
development environment for security reasons.

If you wish to run the suite of JUnit test cases against the API you must
provide a file named " TestConstants.properties" at the head of the classpath
before running the tests. For example:

java -cp TestConstants.properties;<rest of CP> com.kallasoft.smugmug.api.rest.<version>.AllTests

The test implementation will pick up the properties file from the classpath and use it's values for the sensitive information when executing.

The format of the properties file is as follows:

  • api_key=String, Your API key from SmugMug
  • user_id=Integer, Your user ID
  • username=String, Your login or username
  • nick_name_1=String, a nick name of an account that has atleast 50 public albums available
  • nick_name_2=String, a nick name of an account that has atleast 10 public albums available
  • password=String, The password used to log the given username above in
  • password_hash=String, the hash code of your password. (See withPassword method)

SmugMug JSON API Examples

This section of the document provides links to the extensive Request/Response API documentation for each version of the the SmugMug JSON API that is supported.