https://github.com/pcon/humblemug
A library for interacting with the SmugMug API
https://github.com/pcon/humblemug
Last synced: about 1 year ago
JSON representation
A library for interacting with the SmugMug API
- Host: GitHub
- URL: https://github.com/pcon/humblemug
- Owner: pcon
- License: gpl-2.0
- Created: 2015-02-14T15:11:52.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-02-17T23:05:30.000Z (over 11 years ago)
- Last Synced: 2024-05-02T00:11:30.559Z (about 2 years ago)
- Language: JavaScript
- Size: 152 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A Node.js library for SmugMug
This library is very much in it infancy and only support a small number of methods that the SmugMug 1.3.0 API supports. These methods should work, but they have not been tested on a large scale. SmugMug states that 1.3.0 is deprecated and will be removed "in the future." It is unlikely that this API will be removed tomorrow since the 2.0 API is still in beta.
# Example Usage
The example below will login and list all of the albums for the user _exampleuser_
```javascript
var humble = require('humblemug');
humble.config({api_key: '1234567890abc'});
humble.login.anon().then(function () {
humble.albums.get('exampleuser').then(function (album_list) {
console.log(album_list);
});
});
```
# Documentation
## config
Config takes in an object of configuration information to store and use.
```javascript
humble.config({api_key: '1234567890abc'});
```
## login
### anon
Most public information can be accessed with after loggining in anonymously
```javascript
humble.login.anon().then(function () {
//Do Stuff
});
```
## albums
### [get](http://api.smugmug.com/services/api/?version=1.3.0&method=smugmug.albums.get)
Lists all of the albums for a given user
```javascript
humble.albums.get('username').then(function (album_list) {
//Do Stuff
});
```
### [getInfo](http://api.smugmug.com/services/api/?version=1.3.0&method=smugmug.albums.getInfo)
Gets all the info for a given album
```javascript
humble.albums.getInfo('album_id', 'album_key').then(function (album_info) {
//Do Stuff
});
```
## images
### [get](http://api.smugmug.com/services/api/?version=1.3.0&method=smugmug.images.get)
Lists all of the images in an album
```javascript
humble.images.get('album_id', 'album_key').then(function (image_list) {
//Do Stuff
});
```
## Additional options
Most SmugMug API calls support additional options. You can call most of these methods with an options object to set additional information.
_NOTE: These options appear to be case sensitive so becareful_
```javascript
var options = {
Heavy: true
};
humble.images.get('album_id', 'album_key', options).then(function (image_list) {
//Do Stuff
});
```