Make Agent Fast hujjatlari

SDK holati

Registrda mavjud deb o‘ylamasdan barqaror REST APIʼni tanlang yoki faqat manba kodi ko‘rinishidagi preview mijozlarni baholang.

Qisqacha koʻrinish

Registrda mavjud deb o‘ylamasdan barqaror REST APIʼni tanlang yoki faqat manba kodi ko‘rinishidagi preview mijozlarni baholang.

API soʻrovi yoʻliCheklangan kalit → versiyalangan resurs → imzolangan javob

REST mavjudOpenAPISDK preview

Bugungi kunda versiyalangan REST API qo‘llab-quvvatlanadigan ochiq integratsiya yuzasidir. Mahsulot repozitoriysida JavaScript, Python va freymvork mijozlarining manba kodi bor, ammo paketlar hozircha npm yoki PyPIʼda chiqarilmagan.

Mavjudlik#

Mijoz	Holat	Qanday foydalaniladi
HTTPS orqali REST	Mavjud	Istalgan server HTTP mijozidan `https://makeagent.fast/api/v1`ni chaqiring
OpenAPI hujjati	Mavjud	Mijoz yaratishdan oldin /api/openapi.json faylini yuklab, tekshiring
`@make-agent-fast/sdk`	Manba kodi previewʼsi — npmʼda yo‘q	Bu yerda registr relizi havolasi paydo bo‘lmaguncha importni ishlab chiqarish loyihasiga qo‘shmang
`makeagentfast` Python paketi	Manba kodi previewʼsi — PyPIʼda yo‘q	PyPI relizi havolasi paydo bo‘lguncha `requests`, `httpx` yoki Python standart kutubxonasidan foydalaning
React, Vue, Svelte adapterlari	Manba kodi previewʼsi — npmʼda yo‘q	Freymvork uchun hujjatdagi skript yuklagich usulini tanlang
Web component	Manba kodi previewʼsi — npmʼda yo‘q	Standart `embed.js` yuklagichidan foydalaning

SDKʼsiz JavaScript#

const response = await fetch("https://makeagent.fast/api/v1/sites?limit=100", {
  headers: {
    Authorization: `Bearer ${process.env.MAF_API_KEY}`,
    Accept: "application/json",
  },
});

const body = await response.json();
if (!response.ok) {
  console.error(body.error.code, body.error.request_id);
  throw new Error(`Make Agent Fast request failed (${response.status})`);
}

for (const site of body.data) console.log(site.id, site.title);

API kalitini serverda saqlang. React, Vue yoki Svelte brauzer paketi o‘z backendingizni chaqirishi yoki ochiq embed yuklagichini o‘rnatishi kerak; u boshqaruv APIʼsini maxfiy kalit bilan chaqirmasligi kerak.

SDKʼsiz Python#

import json
import os
import urllib.request

request = urllib.request.Request(
    "https://makeagent.fast/api/v1/sites?limit=100",
    headers={
        "Authorization": f"Bearer {os.environ['MAF_API_KEY']}",
        "Accept": "application/json",
    },
)

with urllib.request.urlopen(request, timeout=20) as response:
    payload = json.load(response)

for site in payload["data"]:
    print(site["id"], site["title"])

Ishlab chiqarishda urllib.error.HTTPErrorni ushlang va uning JSON tanasini barqaror xato qobig‘i bo‘yicha ajrating.

Yaratilgan mijozlar#

OpenAPI orqali mijoz yaratish faqat hujjatda ilovangiz tayangan amallar va sxemalar bo‘lsa foydali. Yuklab olingan spetsifikatsiya versiyasini mahkamlang, kodni tekshirish mumkin bo‘lgan papkaga yarating va yangilashdan oldin har bir farqni ko‘rib chiqing.

curl --fail-with-body https://makeagent.fast/api/openapi.json \
  --output make-agent-fast.openapi.json

Jonli URLʼdan mijozni avtomatik qayta yaratib, joylashtirmang. Yangi qo‘shimcha maydon mijozni buzmasligi kerak, ammo generator ishlashi va yaratilgan metod nomlari baribir o‘zgarishi mumkin.

Ochiq SDK relizida nimalar bo‘lishi shart#

Har qanday preview mijoz “mavjud” deb belgilanishidan oldin unda quyidagilar bo‘lishi kerak:

Ochiq registr sahifasi va o‘zgarmas semantik versiya.
O‘rnatish, yangilash va qo‘llab-quvvatlanadigan runtime bo‘yicha ko‘rsatmalar.
To‘liq API shartnomasidan yaratilgan turlangan so‘rov va javob modellari.
HTTP holati va request IDʼni saqlaydigan tuzilmali xatolar.
Cursorlarni yopiq qiymat deb ko‘radigan sahifalash yordamchilari.
O‘zgartirish amallari uchun aniq idempotency-key qo‘llovi.
Joriy /api/v1 shartnomasi bilan CI testlari va eʼlon qilingan o‘zgarishlar tarixi.

Bu shartlar bajarilguncha APIʼni tez boshlash va API retseptlaridagi REST misollaridan foydalaning.