1.新APIリリースについて
2021年8月18日より新API(https://api.customer.jp/cloudwan/v1)が利用可能となります。なお、旧API(https://api.onewan.cloud/v1.0)は、2022年2月末まで並行利用が可能です。2022年3月以降はご利用できなくなるため、それまでに新APIへの設定変更をお願いいたします。新APIのご利用例については、こちらのMaster'sONE CloudWAN API 利用ガイドを参照ください。
新旧APIの変更点について
変更点は、「APIのURL」と「テナントIDの指定」となります。
1.APIのURL
新旧APIでコール先のURLが変更となるため、APIクライアント側でコール先のURLの設定変更をお願いいたします。
2.テナントIDの指定
URL | |
旧API | https://api.onewan.cloud/v1.0 |
新API | https://api.customer.jp/cloudwan/v1 |
2.テナントIDの指定
新APIでは一部のクエリにて、クエリパラメータにテナントID(tenant_id:uuid形式)を指定する必要があります。詳細についてはAPIドキュメント(http://apidocs.onewan.cloud/)も合わせてご確認ください。
クエリの例 | 備考 | |
旧API | 例:拠点の設定情報を取得する場合
/cloudwan/sites |
|
新API | 例:拠点の設定情報を取得する場合
/cloudwan/sites?tenant_id=tenant_id(uuid形式) |
/cloudwan/* ではじまるクエリには全て、クエリパラメータにテナントIDを付与してください。/cloudwan/* ではじまるクエリの一覧や詳細については、以下APIドキュメントをご確認ください。http://apidocs.onewan.cloud/ |
新APIのご利用にあたっての注意点
新APIを初めてご利用される場合には、以下の事前設定が必要となります。
なお、2回目以降は不要です。
1.WEBブラウザにて新APIのURL(https://api.customer.jp/cloudwan/v1)を入力してログインページを表示させる。
2.お客様がご利用しているIDとパスワードを入力し、ログインボタンを押す。
3.初回設定画面にてAuthorizeボタンを押す。
4.アクセストークンが払い出されることを確認する。
5.2回目以降は以下コマンドでトークン取得が可能となります。
USERNAME="コントロールパネルのログインID"
PASSWORD="コントロールパネルのログインパスワード"
CSRF=`curl -k -c cookie.txt -L -D - 'https://api.customer.jp/cloudwan/v1/' | awk '$0~/name="_csrf"/{print $4}' | awk -F '"' '{print $2}'`
REDIRECT_URL=`curl -c cookie2.txt -b cookie.txt -D - -X POST --http1.1 -d "_csrf=${CSRF}" -d "username=${USERNAME}" -d "password=${PASSWORD}" 'https://portal.onewan.cloud/auth/login' | awk '$1~/^Location/{print $2}'`
ACCESS_TOKEN=`curl -b cookie2.txt -L -X GET "${REDIRECT_URL%$'\r'}" | jq -r ".access_token"`
コメント
0件のコメント
記事コメントは受け付けていません。