RICOH Cloud API (Beta)

RICOH Cloud API (or Ricoh API) is a cloud API which enables you to access BaaS (Backend as a Service) for imaging devices including THETA. You can use RICOH Cloud API after you complete your entry of RICOH THETA × IoT Developers Contest presented by RICOH.

What’s New


RICOH Cloud API requires Ricoh API Client Credentials (client ID and client secret) and User ID.

See User Account Setup Guide for more information.

Getting Started

The following instructions are designed to show you the common usage of RICOH Cloud API in your projects. See SDK & Sample Apps for detailed instructions on each SDK. In the instructions below, Media Storage SDK for JavaScript is used as an example.

1. Install an SDK

$ npm install ricohapi-mstorage

2. Load and Set Up the SDK Modules

const MStorage = require('ricohapi-mstorage').MStorage;
const AuthClient = require('ricohapi-mstorage').AuthClient;

const client = new AuthClient('<your_client_id>', '<your_client_secret>');
client.setResourceOwnerCreds('<your_user_id>', '<your_password>');

const mstorage = new MStorage(client);

NOTE: You need to pass your Ricoh API Client Credentials and User ID to the client module.

3. Connect to the Ricoh Cloud Server

.then(() => console.log('connected'));

4. Enhance Your Project

Now you can use the methods provided in the SDK to enhance your project. The following examples shows how to upload and download image files.

Upload a .jpg file to the cloud storage

.then(() => console.log('uploaded'));

List IDs of uploaded files

.then(list => console.log(list));

If successful, you see a list of files with the following structure:


Download a file by ID

mstorage.downloadTo('download_media_id', './download_file_path.jpg')
.then(() => console.log('downloaded'));

SDK & Sample Apps

Media Storage

Image Processing

Video Streaming

Camera Control