rinkak Developerに登録する

rinkakにログインします。
画面右上のアイコンのプルダウンメニューから「アカウントの設定」へ移動します。
「rinkak Developerに登録する」というチェックボックスをONにします。
「更新する」ボタンをクリックすると登録完了です。
rinkak DeveloperをONにすると、「ショップの設定」に[shop_secret]が表示されます。 これはAPIリクエストで利用する文字列です。

アプリを登録する

rinkak developerに登録が完了していると、右上のアイコンのプルダウンメニューに「アプリ」の項目が追加されます。
「アプリ」に移動して、「アプリの新規登録」を行うことでアプリを作ることが出来ます。
「アプリ」に必要な項目は以下のとおりです。

Redirect URIはOAuth2.0のAuthorization Codeを受け取るサイトのURIを指定して下さい。
IconとNameはユーザに表示されます
Icon、Name、Description、Web Site URLはブランディング素材として利用します。
アプリの登録が完了するとclient_idとclient_secretが取得できます。これらを利用してOAuth2.0認証を行います。

OAuth2.0による認証認可手順

各種APIをクライアントプログラムから利用するためには、OAuth 2.0 Protocolにより規定された認可を行うことが求められます。
この手順により、クライアントプログラムがどのようなAPIアクセスを行い、そしてどのような情報が参照または更新されるのか（これをスコープと呼びます）がユーザに提示されます。
ユーザの認証、および提示されたスコープについてユーザが同意した場合にのみ、クライアントプログラムはAPIにアクセスするための情報（トークンなど）を得ることができます。

1. 認可とAuthorization Codeの入手

最初にクライアントプログラムは、HTTP GETメソッドにて下記のURLにアクセスします。

URL	https://www.rinkak.com/oauth2/auth
(パラメータ)
client_id	アプリ情報で表示されているclient_idの値
redirect_uri	アプリ情報で設定したredirect_uriの値
scope	cart product

ブラウザで下記のURLを直接開くとアクセス許可の通知が開きます。
scopeで指定する範囲が複数ある場合は半角スペース区切りで複数個を指定します。

具体的には以下のようなアクセスになります。

https://www.rinkak.com/oauth2/auth?client_id=[アプリ情報のclient_id]&redirect_uri=[アプリ情報で登録したredirect_uri]&scope=cart product

ユーザはブラウザで下記のような認証認可の確認画面が表示されます。

ユーザが「アクセスを許可」のボタンを押すとAuthorization Codeがredirect_uriのcodeパラメータとして受け取れます。

[redirect_uri]?code=[Authorization Code]

なお、ユーザが「許可しない」をクリックした場合はcodeパラメータの含まれない[redirect_uri]にリダイレクトされます。
このAuthorization Codeの有効期限は600秒(10分)です。
10分を超えた場合はAuthorization Codeが無効化されますので、再び初めからAuthorization Codeを取得する必要があります。

curl -d client_id=[アプリ情報のclient_id] -d client_secret=[アプリ情報のclient_secret] -d redirect_uri=[アプリ情報で登録したredirect_uri] -d grant_type=authorization_code -d code=[Authorization Code] https://www.rinkak.com/oauth2/token

{"access_token": "[アクセストークン文字列]", "tokeny_type": "Bearer", "expires_in": 3600, "refresh_token": "[リフレッシュトークン文字列]"}

プロダクト情報を取得するAPI

プロダクト情報を取得するには以下のURIにHTTP GETリクエストします。
product_secretもしくはshop_secretを指定する場合はPOSTリクエスで受け付けており、製造可能かつ非公開なプロダクトにもアクセスすることができます。

カートにプロダクトを登録するAPI

ユーザに代わってサービス(アプリ)が指定のプロダクトをユーザのカートに追加するAPI。
これにより、サービス(アプリ)が独自のプロダクトをカートに追加でき、ユーザをそのまま購入へ導くことができます。
カートにプロダクトを追加した後の実際の購入フローはブラウザで行います。

カートにプロダクトを登録するには以下のURIにHTTP POSTリクエストします。

素材情報一覧を取得するAPI

素材情報を取得するには以下のURIにHTTP GETリクエストします。

プロダクトを登録するAPI

本APIを利用したい場合はrinkakのお問合せフォームからご相談下さい。 個別に対応させて頂きます。

ショップ情報を取得するAPI

ショップ情報を取得するには以下のURIにHTTP GET/POSTリクエストします。shop_secretを指定することで、製造可能かつ非公開なプロダクトにもアクセスすることができます。

3DモデリングAPI

3DモデリングAPIは簡単な座標データを送信することで3Dプリントできるモデルデータ(OBJやWRL)を作ることができるAPIです。 指定した座標位置に立方体のカラーボックスを配置したモデルデータを作ることができます。
以下のURIにHTTP POSTリクエストします。

dataパラメータ

data = '[ [0,0,0,"FF0000"], [1,0,0,"0000FF"], [0,1,0,"00FF00"], [0,0,1,"FFFFFF"] ]'

signatureパラメータ

var data =  '[ [0,0,0,"FF0000"], [1,0,0,"0000FF"], [0,1,0,"00FF00"], [0,0,1,"FFFFFF"] ]';
var secret = 'abcdef';
var signature = CryptoJS.MD5(data + secret);
console.log( signature );
> '536d7f25b313fcace72089e0f6880540'

curl -d client_id=[アプリ情報のclient_id] -d length=2 -d data='[ [0,0,0,"FF0000"], [1,0,0,"0000FF"], [0,1,0,"00FF00"], [0,0,1,"FFFFFF"] ]' -d signature=536d7f25b313fcace72089e0f6880540 https://www.rinkak.com/api/v1/model/make

3Dモデルデータを取得するAPI

本APIは3DモデリングAPIで作成したモデルを取得するAPIです。 本APIへアクセスするエンドユーザはOAuth2.0で認証済みである必要があります。
以下のURIにHTTP GETリクエストします。