SmugMug API v2 is a "REST" API.

The REST concept has a long history, and not everyone agrees on what it means. For the SmugMug API, REST means:

• Every object (such as an album, folder, image, or user) has a canonical identifying URI
• Actions are performed by using the right HTTP method on an object's URI
• Different HTTP status codes are used to convey different kinds of problems and different kinds of successful outcomes

HTTP Methods

Object Identifiers

API v2 uses URIs to identify objects. For example, /api/v2/user/cmac identifies a user. When one object references another, it does so by URI. Thus, when you are using an endpoint that takes a reference to another object as an argument, you must send the API URI for that object as the argument.

For example, suppose you have an image /api/v2/image/53PwQMN-0 and an album /api/v2/node/LTQMF. To set that image to be that album's highlight image, you make a PATCH request to the album URI and pass the image URI as an argument:

Creating Objects

Creating an object is done by making a POST request to the endpoint which returns the set of objects which are siblings of the one you want to create. That sounds complicated, but it's simple in practice. For example, let's say you want to create a new album under the folder /api/v2/node/tqzx6. The new album would be the sibling of any nodes returned by /api/v2/node/tqzx6!children, so that's the endpoint where you should POST:

Status Codes