2. XREA API
① コントールパネルにログインする
メモ
配布している ID と PASS と サーバー を確認してください。
② API URLの確認
API URL(https://api.xrea.com) をクリックして、アクセスしてみてください。
③ 表示内容を確認
簡単に分解してみましょう。
{
“status_code”:500,
“error_target”:“api_secret_key”,
“error_message”:“empty”,
“error_code”:100001
}
④ 使い方を調べよう
API ドキュメントURL (https://apidoc.xrea.com)
■今回は下記2つだけ確認
共通 - APIステータスコード
共通 - APIエラーコード
⑤ ドキュメントを確認した上で、再度表示内容を確認
それでは簡単に分解してみましょう。
{
“status_code”:500, // エラーが発生している
“error_target”:“api_secret_key”, // エラーの対象は「api_secret_key」
“error_message”:“empty”, // 入力された値が空です
“error_code”:100001 // 上記と同様なので省略
}
これらを組み合わせて理解すると 「api_secret_keyの入力が空でエラーが出ている」
となります。
⑥ コントロールパネルからデータベースを操作してみよう
現在設定されているmysqlをコントロールパネルで確認
XREAコントロールパネル(Mysql) https://cp.xrea.com/database/mysql
・設定されているmysql一覧を取得する
現在接続しているXREAサーバで下記を実行してください。
なお、「アカウント名」と、「APIシークレットキー」と書かれている所は、
ご自身の情報に変更してください。
curl -X POST \
-d "account=アカウント名" \
-d "server_name=s1007.xrea.com" \
-d "api_secret_key=APIシークレットキー" \
-d "db_type=mysql" \
https://api.xrea.com/v1/db/list | jq .
メモ
上記コマンドでは「アカウント名」「APIシークレットキー」の情報をお手元の情報に変更していただく必要がありますので、一度お手元のテキストエディターで変更作業を行ってからターミナルへ貼り付けて下さい。
マニュアルは以下
⑦ APIからdatabaseを追加する
■databaseを追加する
こちらは、「アカウント名」と、「APIシークレットキー」と書かれている所に加えて、
「データベース名」「データベースパスワード」を、ご自身の情報に変更してください。
メモ
※データベース名は、頭に「アカウント名_」という接頭詞を付けてください。
※アカウント名が「test001」の場合、「test001_sampledb」等になります。
※データベースパスワードはご自由にお決め下さい。
curl -X POST \
-d "account=アカウント名" \
-d "server_name=s1007.xrea.com" \
-d "api_secret_key=APIシークレットキー" \
-d "param[0][db_name]=データベース名" \
-d "param[0][db_pass]=データベースパスワード" \
-d "param[0][code]=unicode" \
-d "db_type=mysql" \
https://api.xrea.com/v1/db/add | jq .
DBの追加が完了したら、再度下記のXREAコントロールパネルから、
ターミナルで追加したデータベースが表示されている事を確認して下さい。
XREAコントロールパネル(Mysql)
マニュアルは以下になります。お時間あまりましたら見ておいて下さい。
DB新規作成
(https://apidoc.xrea.com/#/site/2017/07/19/db_add.html)
⑧ 以上XREAでした。
XREAは以上になります。 今回はDBのAPIを利用しましたが、ドキュメントを見ていただくと多数の機能があります。 XREAは無料でご利用できますので、APIの練習機として是非ご利用いただければと思います。