README

Airtable API 的 PHP 封装。

入门

Airtable API 不允许操作基础或表中的字段。因此，您必须在 Airtable 界面中手动创建表及其字段。

重要

每个基础都有自己的文档，其中包含 base 标识符（以 app 开头，例如 appGYr9gxkAk0wKNk），这是必需的参数。API 密钥位于 账户设置。

安装

安装 davidzadrazil/airtable-api-php 的最佳方式是使用 Composer。

$ composer require davidzadrazil/airtable-api-php

用法

初始化

首先，您必须初始化 Airtable 类和请求处理程序

$airtable = new DavidZadrazil\AirtableApi\Airtable('API_KEY', 'BASE_ID');
$request = new DavidZadrazil\AirtableApi\Request($airtable, 'TABLE_NAME');

获取记录

重要：Airtable 限制响应的最大记录数为 100 条。

$tableRequest = $request->getTable();
do {
  foreach ($tableRequest->getRecords() as $record) {
    echo $record->getName();
    echo $record->getEmail();
    echo $record->getAnotherValue();
  }
} while ($tableRequest = $tableRequest->nextPage());

getRecords() 返回一个 AirtableApi\Record 数组。

过滤及其他参数

获取表中的记录可以使用诸如 filterByFormula、maxRecords、pageSize、sort 或 view 等可用参数。

$request->getTable(['pageSize' => 50, 'filterByFormula' => '{Name} = "test"']);

创建记录

$response = $request->createRecord(
  [
    'Name' => 'This appears in Name field',
    'Email' => 'john@doe.com',
    'LinkToAnotherTable' => ['recsH5WYbYpwWMlvb']
  ]
);

$response->isSuccess(); // true / false
$response->getRecords(); // returns newly created record with ID

更新记录

使用给定的记录 ID 更新特定记录。

$response = $request->updateRecord('recsH5WYbYpwWMlvb', ['Name' => 'Updated value']);
$response->isSuccess(); // true / false

删除记录

使用给定的记录 ID 删除特定记录。

$response = $request->deleteRecord('recsH5WYbYpwWMlvb');
$response->isSuccess(); // true / false