LoginSignup
26
19

More than 5 years have passed since last update.

Airtable API の使い方

Posted at

Airtable ドキュメント

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

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

airtable11.png

API docs INTRODUCTION

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

airtable12.png

API docs AUTHENTICATION

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

API docs TABLE、Fields 情報

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

airtable13.png

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"
        },

airtable14.png

API docs Retrieve a record

最終レコードが応答されるらしい。
使い道は?

API docs Create a record

1レコード追加のAPI。項目と値を指定するだけなので、シンプル。

airtable15.png

API docs Update a record

1レコード更新のAPI。

airtable16.png

API docs Delete a record

1レコード削除のAPI。

airtable17.png

API ROADMAP

ロードマップに一つ気になるのがあって、更新レコードを知らせてくれるというもの。
イベント処理として使えるとうれしい。

Receiving notifications about changed records.

26
19
4

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
26
19