DoRuby

BoxのAPIを使って見よう。(その1) ～概要とAPIのことについて

アピリッツ広報担当

作成: 2017.06.16 更新: 2021.03.05

Box API を使う上でのポイント4つ
1.RESTful API とは
2.JSON とは
3.OAuth2.0 とは
- a.概要
- b.一般的なフロー
4.Box Developer アカウント
アクセストークン取得に必要な情報
BOX API reference
まとめ

この記事はアピリッツの技術ブログ「DoRuby」から移行した記事です。情報が古い可能性がありますのでご注意ください。

Box API を使う上でのポイント4つ

RESTful API
JSON
OAuth2.0
Box Developer アカウント

1.RESTful API とは

ウェブシステムのHTTPでの呼び出しインターフェース
GET、POST、PUT、DELETE等のHTTP標準のメソッドを使い、「何を」「どうする」というようにシンプルな表現されのが特徴です。

a.URL

https://api.box.com/2.0/files/123456789
　　files の中の ID：123456789 のファイルを取得
https://api.box.com/2.0/files/123456789/versions
　　files の中の ID：123456789 のファイルのバージョンを取得

b.HTTPメソッド（他にもありますが、今回は以下の4つ）

GET
　　リソースの獲得
POST
　　リソースの作成
PUT
　　リソースの更新（状態変更）
DELETE
　　リソースの削除

c.curl（データを転送するライブラリ）を使った例

$ curl -X GET https://api.box.com/2.0/files/123456789

curl については、こちら　見て下さい。

2.JSON とは

JSONとはJavaScript Object Notationの略で、XMLなどと同様のテキストベースのデータフォーマットです。
{} (カッコ)で括られている文字で、整形すると下記のようになります。

  {
      "entries" : [
          {
              "created_at": "2012-08-20T10:20:30-07:00",
              "id": "672259576",
              "modified_at": "2012-11-28T13:14:58-08:00",
              "modified_by": {
                  "id": "183732129",
                  "login": "sean+apitest@box.com",
                  "name": "sean rose",
                  "type": "user"
              },
              "name": "Dragons.js",
              "sha1": "359c6c1ed98081b9a69eb3513b9deced59c957f9",
              "size": 92556,
              "type": "file_version"
          }
      ],
      "total_count": 1
  }