API гэж юу вэ? App бүтээгчдэд зориулсан энгийн гарын авлага

API (application programming interface) бол нэг программ хангамж нөгөөгөөсөө өгөгдөл авах, эсвэл юм хийлгэх тодорхойлсон арга юм. Таны app тохиролцсон форматаар хүсэлт илгээдэг — «маргаашийн захиалгуудыг өг», «энэ картнаас €20 тат», «энэ текстийг товчил» — мөн нөгөө систем бүтэцтэй хариу буцаадаг. API бол app-ийн хэсгүүд хоорондоо ярилцдаг арга, мөн таны app төлбөр, имэйл, газрын зураг, AI зэрэг гадны үйлчилгээг ашигладаг арга юм.

AI-аар бүтээхэд API яагаад чухал вэ

Бараг бүх ашигтай app нь API-аар харилцдаг хэсгүүдээс бүрдсэн байдаг:

• App-ийн дотор, хөтөч дэх дэлгэцүүд өгөгдөл ачаалах, хадгалахын тулд таны өөрийн backend-ийн API-г дуудна.
• App-ийн гадна, таны backend бусад компаниудын API-г дуудна: Stripe төлбөр авах, имэйл үйлчилгээ баримт илгээх, AI загварын үйлчилгээ текст үүсгэх.

AI builder-ээс «төлбөр ав» эсвэл «AI хураангуй нэм» гэж гуйхад тэр үнэндээ API дуудах код бичиж байгаа юм. Үндсийг мэдвэл AI-д таснаас юу хэрэгтэйг (ихэвчлэн тэр үйлчилгээний данс болон API түлхүүр), юу буруу болж болох газрыг, мөн тэдгээр юу зардалтай болохыг ойлгоход тусална.

Өдөр тутмын жишээ

Ресторан гэж бод. Та гал тогоонд орж хоол хийдэггүй. Та цэс уншиж, гал тогоо ойлгох хэлбэрээр зоогчиндоо хэлнэ, зоогч хоолыг чинь авчирна — эсвэл тэр хоол дууссан гэж хэлнэ.

• Цэс бол API-ийн баримт бичиг: юуг хэрхэн гуйж болох жагсаалт.
• Зоогч бол API: хүсэлт орж, хариу гарах нэг тохиролцсон арга.
• Гал тогоо бол нөгөө систем: дотор нь хэрхэн ажилладагийг мэдэх шаардлагагүй.
• Таны захиалга бол хүсэлт; таваг бол хариу.

Цэс хэвээр байвал гал тогоо зуухаа болон ажилтнуудаа сольж болно, та мэдэхгүй. Энэ бол API-ийн жинхэнэ үнэ цэнэ: хоёр систем бие биенийгээ хэрхэн бүтсэнийг мэдэлгүйгээр хамтран ажиллуулдаг.

Вэб API хүсэлт хэрхэн ажилладаг вэ

Та таарах ихэнх API бол HTTP дээр ажилладаг вэб API бөгөөд энэ нь таны хөтөч ашигладаг протоколтой адил. Хүсэлт бүр хэд хэдэн хэсэгтэй:

Хариу бүр ийм хэсгүүдтэй:

JSON (JavaScript Object Notation) бол нэр, утгуудыг нугалсан хаалтанд бичдэг энгийн текст формат юм. Вэб API өгөгдөл солилцдог стандарт арга юм.

REST: хамгийн түгээмэл хэв маяг

REST бол вэб API-г зохион бүтээх өргөн хэрэглэгддэг конвенц юм. Зүйл бүр өөрийн URL-тай байж, стандарт аргууд нь таныг юу хийж буйг заана. Захиалгын app-ийн REST API ийм байж болно:

PUT ч бас байдаг бөгөөд конвенцоор бүхэл бичлэгийг сольдог, харин PATCH зөвхөн илгээсэн талбаруудыг өөрчилдөг.

Хамгийн их таарах статус кодууд:

App эвдрэх үед статус код ихэвчлэн хамгийн хурдан дохио болдог. Төлбөрийн үйлчилгээнээс ирсэн 401 ихэвчлэн API түлхүүр дутуу эсвэл буруу гэсэн үг; 429 нь хэт олон удаа дуудаж байгааг заана.

REST цорын ганц хэв маяг биш — GraphQL болон RPC хэв маягийн API ч байдаг — гэхдээ ихэнх үйлчилгээ болон AI-аар бүтээсэн backend-үүд REST ашигладаг.

Жишээ: захиалгын баталгаажуулалт

Нэг салоны app-д үйлчлүүлэгч үсний засалт захиалахад хэд хэдэн API дуудалт нэг эсвэл хоёр секундэд болж болно:

1. Хөтөч дэх захиалгын хуудас үйлчилгээ, цаг, харилцагчийн мэдээллийг бүхий POST /api/bookings хүсэлтийг таны backend руу илгээнэ.
2. Таны backend цаг чөлөөтэй эсэхийг шалгаж, захиалгыг өгөгдлийн сан-д хадгалж, 201 Created буцаана.
3. Таны backend имэйл үйлчилгээний API-г нууц түлхүүрээрээ дуудна: «энэ баталгаажуулалтыг lena@example.com руу илгээ.»
4. Урьдчилгаа төлбөр байвал таны backend төлбөрийн үйлчилгээний API-д checkout session үүсгэхийг хүсч, үйлчлүүлэгчийг тийшээ чиглүүлнэ.
5. Хожим нь төлбөрийн үйлчилгээ таны app-д дуудаж, төлбөр амжилттай болсныг мэдэгдэнэ. Энэ урвуу дуудлага нь webhook юм.

Эхний хоёр алхам бол frontend ба backend-ийн хоорондох өөрийн API. 3–5 дахь алхмууд бол гуравдагч талын API-ууд.

Гол нэр томъёо

Түгээмэл алдаа, буруу ойлголт

• Нууц түлхүүрийг frontend-д тавих. Хөтөчид ажилладаг кодод байгаа зүйлийг зочилдог хэн ч харж болно. Нууц түлхүүр серверт, орчны хувьсагч эсвэл нууцлалт-д үлдэх ёстой.
• Түлхүүрийг чатад наах. Чатын түүх хадгалагдаж магадгүй. Оронд нь builder-ийнхээ нууцлалтын функцийг ашигла, илрүүлсэн аливаа түлхүүрийг солих.
• API үнэгүй гэж бодох. Олон API хүсэлт бүрээр эсвэл ашиглалтын нэгжээр төлбөр авдаг — AI загварын API токеноор төлбөр авдаг. Үнийг шалгаж, зарцуулалтын хязгаар тавь. LLM API-г хэрхэн ашиглах вэ-г үзнэ үү.
• Алдааг зохицуулахгүй байх. Гадны үйлчилгээ унах, хугацаа дуусах, хязгаарт хүрдэг. Ухаалаг алдааны мессеж болон дахин оролдлого хүс.
• Хөтөчид итгэх. Таны өөрийн API эрхээ өөрөө шалгах ёстой. Товчийг нуух нь хэн нэгэн endpoint-ийг шууд дуудахаас сэргийлдэггүй.
• Туршихдаа жинхэнэ түлхүүр ашиглах. Launch-д бэлэн болтол test mode-ийн түлхүүр ашигла.

AI builder-тээ юу гуйх вэ

• «Энэ app аль гадны API-г ашигладаг вэ, тус бүр нь ямар зардалтай вэ?»
• «Төлбөрийн API-г зөвхөн серверээс дуудаарай. Түлхүүрийг орчны хувьсагчаас унш.»
• «Манай API-ийн endpoint бүрийг, юу хийдэг, хэн дуудаж болохыг жагсаа.»
• «Захиалгыг шинэчлэх эсвэл устгахаас өмнө нэвтэрсэн хэрэглэгч уг захиалгын эзэн мөн эсэхийг серверт шалга.»
• «Имэйлийн API бүтэлгүйтвэл захиалгыг хадгалаад алдааг бүртгэ.»
• «Одоохондоо үйлчилгээ үзүүлэгчийн test mode ашигла.»

Mythex дэх API

Mythex өөрийн API-г бүтээж чадна — вэб app-ийн нэг хэсэг болгон, эсвэл frontend-тэйгээ зэрэгцэн ажилладаг Node, Python (FastAPI), C# эсвэл Java-ээр бичигдсэн тусдаа backend болгон — мөн гадны үйлчилгээг дуудах кодыг бичнэ. Тэдгээрийн түлхүүрийг чатад биш төслийнхөө нууцлалт болгон нэмнэ; тэд preview дээр болон нийтэлсний дараа app-д боломжтой байна. Docs-д ямар ч API-г холбох болон REST API backend бүтээх-ийн жор байдаг.

Асуултууд