บทช่วยสอน AIRTABLE API ด้วย CURL และ JAVASCRIPT

หากคุณกำลังมองหาวิธีที่รวดเร็วและง่ายดายในการยืนยันข้อมูลแอปพลิเคชันของคุณ อย่ามองข้าม Airtable โดยทั่วไปแล้ว Airtable นั้นเป็นแผ่นงาน Excel เช่นฐานข้อมูลที่มีความยืดหยุ่นมากมายและมี GUI สำหรับตรวจสอบ/สร้างข้อมูล

สารบัญ

เริ่มต้น
API
การตรวจสอบสิทธิ์
ตารางโครงการออกแบบ
โครงสร้าง URL ของ API
การดำเนินการ CRUD ด้วยคำขอ HTTP ในบุรุษไปรษณีย์
รายการบันทึก
ดึงบันทึก
สร้างบันทึก
อัพเดทบันทึก
ลบบันทึก
การดำเนินงาน CRUD ด้วย JavaScript
การตั้งค่าและการเริ่มต้น
รับบันทึก
รับบันทึก
สร้างบันทึก
อัพเดทบันทึก
ลบบันทึก
การจัดการข้อผิดพลาด
สรุป

ฉันเคยใช้ Airtable เป็นฐานข้อมูลสำหรับแอปสาธิตบางแอปเมื่อเร็วๆ นี้ และฉันชอบมันมาก มีตัวเลือกที่ยอดเยี่ยมอื่น ๆ เช่น Firebase เป็นต้น แต่ Airtable ดูเหมือนจะง่ายที่สุดสำหรับฉัน ในบทความนี้ เรามาสำรวจวิธีสร้างฐาน (คำของ Airtable สำหรับฐานข้อมูล) จากนั้นดำเนินการ CRUD (สร้าง อ่าน อัปเดต และลบ) กับมันในสองวิธีที่แตกต่างกัน คำขอ HTTP ดิบและแพ็คเกจ Airtable JavaScript บน NPM .

เริ่มต้น

เช่นเดียวกับผลิตภัณฑ์ส่วนใหญ่ในปัจจุบัน คุณสามารถสมัครใช้งาน Airtable ได้ฟรี พวกเขามีระดับที่ชำระเงินแล้ว แต่ระดับฟรีนั้นมากเกินพอและอาจอยู่ได้สักพัก ลงทะเบียนที่นี่

ตอนนี้คุณสมัครแล้ว มาสร้างฐานแรกของเรากัน คุณควรจะถูกนำไปที่หน้าจอที่แสดงฐานที่มีอยู่ทั้งหมดของคุณ ฉันมีงานสร้างบางส่วนที่คุณสามารถดูได้ที่นี่

เพื่อจุดประสงค์ในการสาธิต เราจะใช้เทมเพลตที่มีอยู่แทนการสร้างตั้งแต่เริ่มต้น คลิกที่ |_+_| จากนั้นเลือก |_+_|

มาใช้ |_+_| . กันเถอะ แม่แบบ หลังจากนั้นไม่กี่วินาที คุณจะเห็นฐานใหม่ของคุณอยู่ในรายการ ไปเปิดดูเลย เมื่อคุณทำแล้ว สังเกตว่ามีข้อมูลจำลองมากมายที่นี่

ฉันขอแนะนำให้ใช้เวลาสักครู่เพื่อกระตุ้นที่นี่ สองสิ่งที่ควรสังเกตในขณะที่คุณทำ

ข้อมูลมีโครงสร้างคล้ายกับแผ่นงาน Excel
ปรับแต่งประเภทคอลัมน์ได้ (สตริง ตัวเลข วันที่ และอื่นๆ อีกมากมาย)
มีแท็บที่แตกต่างกันสำหรับตารางที่แตกต่างกัน (โครงการออกแบบถูกเลือกโดยค่าเริ่มต้น)
คุณยังสามารถจัดเก็บรูปภาพต่างๆ ไว้เป็นทรัพย์สินได้อีกด้วย

เพียงแค่ใช้ข้อมูลจำลองนี้ คุณจะสัมผัสได้อย่างรวดเร็วว่า Airtable นั้นเจ๋งแค่ไหน!

API

เอกสารประกอบสำหรับ Airtable เป็นข้อดีอีกอย่างหนึ่ง จะอธิบายตัวอย่างการดำเนินการ CRUD ทั้งหมดที่คุณสามารถดำเนินการกับข้อมูลของคุณได้ คุณสามารถค้นหา เอกสาร API ที่นี่ .

จากนั้นเลือกฐานที่เราสร้างขึ้นเมื่อไม่กี่นาทีก่อน สิ่งที่ยอดเยี่ยมคือตอนนี้เอกสารจะเฉพาะเจาะจงกับข้อมูลที่อยู่ในฐานนั้น

สิ่งหนึ่งที่ต้องดูที่ด้านบนของหน้าเอกสารคือ |_+_| ส่วน. สิ่งนี้อธิบายข้อจำกัดเกี่ยวกับจำนวนคำขอต่อวินาทีที่คุณสามารถสร้างไปยัง API

API ถูกจำกัดไว้ที่ 5 คำขอต่อวินาทีต่อฐาน

นอกจากนี้คุณยังสามารถอ่านเพิ่มเติมเกี่ยวกับ ราคาที่นี่ .

การตรวจสอบสิทธิ์

เช่นเดียวกับ API อื่นๆ คุณจะต้องมีข้อมูลรับรองส่วนตัวเพื่อส่งต่อในคำขอ API ของคุณสำหรับ Airtable เพื่อตรวจสอบ ในกรณีนี้ ข้อมูลส่วนตัวคือ |_+_| หากคุณเลื่อนไปที่ |_+_| ส่วนนี้จะบอกคุณอีกเล็กน้อย

ขณะที่เราเลื่อนดูเอกสาร ฉันได้ |_+_| เลือกช่องทำเครื่องหมาย นี่เป็นวิธีที่ง่ายที่สุดในการค้นหาว่าคีย์ของคุณคืออะไร แม้ว่าฉันจะแบ่งปันของฉันในภาพเหล่านี้ แต่ฉันจะเปลี่ยนแปลงเมื่อคุณอ่านข้อความนี้

อย่าแชร์คีย์ API ของคุณกับใครเลย

รหัส API ของคุณจะต้องถูกส่งผ่านเป็น |_+_| ในคำขอ Airtable ของคุณ เพิ่มเติมเกี่ยวกับที่ในวินาที

ตารางโครงการออกแบบ

เมื่อเลื่อนลงไปตามเอกสาร คุณจะเข้าสู่ส่วนที่แสดงรายละเอียดของฟิลด์ที่คุณมีในฐานของคุณ หากคุณเริ่มต้นด้วยเทมเพลตเดียวกับที่อ้างถึงข้างต้น ส่วนนี้จะเรียกว่า |_+_| .

ฉันแค่ต้องการชี้แจงหนึ่งข้อสำหรับการทำงานกับ Airtable |_+_| กำลังอ้างอิงถึงคุณสมบัติที่คุณกำหนดไว้โดยเฉพาะสำหรับแต่ละรายการในตารางของคุณ มีคุณสมบัติบางอย่างที่ Airtable สร้างโดยอัตโนมัติ (รหัสบันทึกและการประทับเวลาที่สร้าง) แต่คุณสมบัติเหล่านี้ไม่รวมอยู่ใน |_+_| คุณจะเห็นการดำเนินการนี้ด้านล่าง

โครงสร้าง URL ของ API

นี่คือวิธีการทำงานของการเรียก API ฉันใช้รายละเอียดเฉพาะสำหรับตัวอย่างของฉัน

URL API ฐาน - https://api.airtable.com/v0/
รหัสตาราง - appu53qW5mpKdJAW2
ชื่อของโต๊ะ - โครงการออกแบบ

คุณนำทั้งหมดนี้มารวมกันแล้วคุณจะได้อะไรแบบนี้

Add a base.

ดังที่ได้กล่าวไว้ก่อนหน้านี้ คุณจะต้องส่งคีย์ API ของคุณเป็น |_+_| เช่นกัน.

การดำเนินการ CRUD ด้วยคำขอ HTTP ในบุรุษไปรษณีย์

อีกครั้งเอกสารเป็นสิ่งที่ดีจริงๆ

รายการบันทึก

เลื่อนลงไปที่ |_+_| และคุณสามารถดูได้ว่าคำขอ HTTPP มีลักษณะอย่างไรในการดึงรายการบันทึก

ใน URL ที่พวกเขาให้ คุณเห็นส่วนต่างๆ ที่เราอ้างถึงข้างต้นหรือไม่ รวมถึงพารามิเตอร์การค้นหาสองสามตัวสำหรับการกรอง

Start With a Template.

มาทดสอบกัน ฉันจะใช้บุรุษไปรษณีย์เพื่อทดสอบคำขอ HTTP เหล่านี้ ภายในบุรุษไปรษณีย์ ฉันเลือกที่จะสร้าง |_+_| ขอส่ง URL แล้วรวมคีย์ API ใน |_+_| ส่วน.

การตอบสนองแต่ละครั้งจาก Airtable จะส่งคืนวัตถุที่มีคุณสมบัติ |_+_| ซึ่งจะเก็บบันทึกทั้งหมดที่เราสอบถามหรือตรวจสอบ มันดีและสม่ำเสมอ!

ดึงบันทึก

ในการดึงข้อมูลบันทึกเฉพาะ เราเพียงแค่ส่ง ID ของระเบียนที่เราต้องการไปยังส่วนท้ายของ API และลบพารามิเตอร์สตริงการสืบค้น คุณสามารถดึง ID ตัวใดตัวหนึ่งออกจากเนื้อหาที่ส่งคืนจากคำขอก่อนหน้า นี่คือ URL ของฉัน

Project Tracker

คุณควรได้รับการตอบสนองเช่นนี้

สร้างบันทึก

ในการสร้างเรกคอร์ด เราใช้ URL ฐานเดียวกันกับที่เราใช้

Rate Limit

ความแตกต่างคือสิ่งนี้กลายเป็น |_+_| ขอและเรารวมบันทึกที่เราต้องการรวมไว้ในเนื้อหาของคำขอ ในการส่งข้อมูล JSON ในบุรุษไปรษณีย์ ฉันมักจะเลือก |_+_| แล้วก็ |_+_|

คล้ายกับการตอบกลับที่เราได้รับจาก Airtable เราส่งวัตถุที่มีคุณสมบัติที่เรียกว่า |_+_| แล้วบันทึกสำหรับแต่ละรายการที่เราต้องการสร้าง

แจ้งให้ทราบในข้อมูลที่ส่งกลับว่าเร็กคอร์ดมีคุณสมบัติใหม่สองประการ |_+_| และ |_+_| . สิ่งนี้ช่วยให้คุณทราบว่าสร้างเร็กคอร์ดสำเร็จแล้ว คุณยังสามารถดูบันทึกใหม่ของคุณใน GUI เพื่อยืนยัน

อัพเดทบันทึก

มีสองวิธีในการอัปเดตเรกคอร์ด

PATCH - สิ่งนี้จะอัปเดตฟิลด์ที่ระบุในบันทึกที่เข้ามา
PUT - นี่คือการอัปเดตแบบทำลายล้างซึ่งจะล้างฟิลด์ใดๆ ที่ไม่ได้ระบุไว้

คุณจะต้องพิจารณาว่าสิ่งเหล่านี้เหมาะสมสำหรับคุณมากกว่า แต่ฉันจะแสดงตัวอย่างโดยใช้ |_+_| . อีกครั้ง URL ฐานเดียวกัน

API Key.

สิ่งเดียวที่ฉันจะอัปเดตในร่างกายคือชื่อ |_+_| .

Authentication

ตรวจสอบ GUI เพื่อดูบันทึกที่อัปเดต

ลบบันทึก

สุดท้ายนี้ เราสามารถลบบันทึกได้ เราทำได้โดยส่ง |_+_| ขอและใส่รหัสบันทึกที่ส่วนท้ายของ URL

show API Key

การตอบสนองที่กลับมายืนยันว่าบันทึกถูกลบไปแล้ว คุณยังสามารถดูใน GUI ได้อีกครั้ง

การดำเนินงาน CRUD ด้วย JavaScript

เอาล่ะ เราได้รับรายละเอียดส่วนใหญ่แล้ว ทีนี้มาดูอย่างรวดเร็วที่ แพ็คเกจ Airtable บน NPM เพื่อดูวิธีทำสิ่งเดียวกันให้สำเร็จโดยใช้ JavaScript

ปี .com/link

เนื่องจากเรากำลังทำซ้ำขั้นตอนต่างๆ ฉันจะข้ามรูปภาพและแสดงเฉพาะข้อมูลโค้ด

การตั้งค่าและการเริ่มต้น

ในโปรแกรมแก้ไขที่คุณชื่นชอบ ให้เปิดโฟลเดอร์และสร้างไฟล์ชื่อ |_+_| จากนั้นเรียกใช้คำสั่งต่อไปนี้เพื่อเริ่มต้นโครงการของคุณเป็นโครงการ JavaScript

bearer token

จากนั้นติดตั้งแพ็คเกจ Airtable

Design Projects Table

ตอนนี้เราต้องเริ่มต้นวัตถุ Airtable ในไฟล์ของเรา

ต้องการ Airtable
สร้างการอ้างอิงถึงฐานของเราโดยใช้คีย์ API และ ID ฐานของเรา
สร้างการอ้างอิงไปยังตารางของเราโดยใช้การอ้างอิงฐานและชื่อตาราง

Fields

สำหรับการดำเนินการ CRUD เราจะใช้ |_+_| ตัวแปรตั้งแต่บัดนี้เป็นต้นไป การโทรแต่ละครั้งที่เราทำจะกลับคำสัญญา ฉันกำลังใช้ |_+_| รูปแบบแทน |_+_| และ |_+_| เพื่อจัดการกับสัญญาที่กลับมา

รับบันทึก

โทร |_+_| ฟังก์ชันซึ่งรับวัตถุที่คุณสามารถรวมพารามิเตอร์การสืบค้นได้ ก่อนหน้านี้เราใช้ |_+_| และ |_+_| , เราก็ทำได้เหมือนกันนี่.

หลังจากโทร |_+_| เราก็ยังต้องโทร |_+_| . นี่เป็นเพราะการแบ่งหน้า ถ้าเรามีบันทึกในตารางของเรามาก เราอาจไม่ต้องการทั้งหมดในคราวเดียว เราจึงสามารถโทร |_+_| เพื่อให้ได้ผลลัพธ์หน้าแรก

fields.

รับบันทึก

หากต้องการบันทึกเฉพาะ เราสามารถโทร |_+_| และส่ง ID ของบันทึกที่เรากำลังมองหา

https://api.airtable.com/v0/appu53qW5mpKdJAW2/Design%20projects

หากคุณออกจากระบบผลลัพธ์ที่นี่ คุณอาจสังเกตเห็นว่ามีข้อมูลมากมายที่ส่งคืน เคล็ดลับหนึ่งที่ฉันใช้คือดึงข้อมูลพิเศษทั้งหมดออก ยกเว้น |_+_| และ |_+_| ฉันสร้างฟังก์ชันย่อขนาดเพื่อทำสิ่งนี้

bearer token

เมื่อ minify เข้าที่ เอาต์พุตบันทึกของฉันจะไปจากสิ่งนี้

สำหรับสิ่งนี้…

สะอาดขึ้นมากใช่มั้ย?