More than 5 years have passed since last update.

Airtable API の使い方

Airtable

Posted at 2016-03-17

#Airtable ドキュメント

Airtable で使用できるのは、REST API です。
kintone JavaScript API のような画面表示のイベント処理で使えるものは、無いようです。
項目情報取得APIもありません。
Listrecords, Retrieve, Create, Update, Delete などがあります。
更新系は１レコード単位のリクエストしかありません。

REST API を調べたいときは、BASE を開いて、API docs のリンクをたどります。

#API docs INTRODUCTION

API の情報は、このdocsにまとめられています。
静的にAPI の説明があるのではなく、BASE にあわせて　API毎に具体的に curl のパラメータと、応答結果が実データで表示されますので、とてもわかりやすいです。

#API docs AUTHENTICATION

API 呼び出し時に必要な認証は、アカウント毎に生成する API.KEY を使います。
API.KEI は、BASE 毎にほしいケースもあると思いますが、アカウントを複数使うなどで対応できると思います。

#API docs TABLE、Fields 情報

BASE に定義されている項目とそのタイプ、実データのサンプルが表示されます。

#API docs Listrecords

Listrecords API の具体的な例と応答結果が表示されます。
そのまんまの実例なので、わかりやすいです。
Max 100 レコードです。

オプションとして、フィルター・ソートなどがあります。
view オプションというのが、BASEで定義した VIEW を指定すると、設定された項目とソートで応答されるらしい。
使い方によっては、便利かもしれない。

EXAMPLE REQUEST
$ curl "https://api.airtable.com/v0/appw0fn10wdcroLRH/%E9%A1%A7%E5%AE%A2%E6%83%85%E5%A0%B1?maxRecords=3&view=%E9%A1%A7%E5%AE%A2%E4%B8%80%E8%A6%A7" \
-H "Authorization: Bearer YOUR_API_KEY"

EXAMPLE RESPONSE
{
    "records": [
        {
            "id": "rec542NQZ4Js2KjCI",
            "fields": {
                "会社名": "顧客A100株式会社",
                "顧客ランク": "A",
                "部署名": "資材部",
                "担当者名": "資材担当者X100",
                "メールアドレス": "xxxxx@xxxxx.co.jp",
                "TEL": "xx-xxxx-xxxx",
                "FAX": "xx-xxxxx-xxxxx",
                "郵便番号": "xxxx-xxxxx",
                "住所": "住所住所住所住所住所住所住所住所住所住所住所住所"
            },
            "createdTime": "2016-03-15T04:12:45.000Z"
        },