Ugrás a fő tartalomhoz
Az alkalmazás API-ja lehetővé teszi, hogy más eszközök dolgozzanak az alkalmazás adataival. Elküldheti például az új űrlapbejegyzéseket egy táblázatba, egy szkripttel minden éjjel frissítheti a rekordokat, vagy egy MI-kódolóasszisztensnek megadhat mindent, ami egy integráció megépítéséhez kell. Az alkalmazás irányítópultjának API oldala elmagyarázza az alkalmazás API-ját, és kimásolható kódot ad, így nem kell a nulláról megírnia.
Az API Documentation oldal a JS SDK legördülő menüvel, valamint az Authentication és az Entity Endpoints szakasszal

Az API oldal az alkalmazás irányítópultján

Kód írása nélkül szeretné más eszközökhöz csatlakoztatni az alkalmazást? Próbálja ki inkább a munkafolyamatokat vagy az összekötőket.

Az API oldal megnyitása

Az API oldal az alkalmazás irányítópultján található, az alkalmazás adatai és naplói mellett. Az API oldal megnyitása:
  1. Kattintson az alkalmazásszerkesztőben az Irányítópult elemre.
  2. Kattintson az API elemre.
  3. Válasszon nyelvet az oldal tetején lévő legördülő menüből: JS SDK, JS Fetch, cURL vagy Python.

Mi található az oldalon

Az oldal szakaszokra oszlik, és a nyelv váltásakor minden kódminta frissül:
  • Hitelesítés: Hogyan jelentkeznek be más eszközök az alkalmazásba. A kérések személyes hozzáférési tokent használnak. Ha még nincs ilyenje, kattintson ebben a szakaszban a Hozzáférési token létrehozása gombra. Ha a JS SDK lehetőséget választotta, ez a szakasz azt is megmutatja, hogyan telepítse a Base44 SDK-t, és hogyan állítsa be az alkalmazás azonosítójával és a tokenjével.
  • Entitásvégpontok: Az alkalmazás minden táblája, egymás mellett a Séma és a Végpontok résszel. Egy tábla referenciájának másolásához kattintson az Entitás másolása, az összes tábláéhoz az Összes másolása gombra. Egy tábla olvasására vagy frissítésére szolgáló kód másolásáról lásd: az adatok csatlakoztatása egy másik alkalmazáshoz.
  • Backend-függvények: Hogyan futtathatja az alkalmazás backend-függvényeit egy másik eszközből. Ha azt szeretné, hogy egy szolgáltatás, például a Stripe meghívjon egy függvényt, amikor valami történik, lásd: webhookok fogadása.
  • Alkalmazásügynök: Hogyan kommunikálhat az alkalmazás beépített ügynökével, például hogyan indíthat beszélgetést, küldhet üzeneteket és kaphat válaszokat.
Az oldalon használt fogalmak:
  • Az entitás az alkalmazás egy adattáblája, például Tasks vagy Orders.
  • A végpont az a cím, amelyre egy másik eszköz kérést küld.
  • A hozzáférési token úgy működik, mint egy jelszó az alkalmazás API-jához.
  • Az OpenAPI egy szabványos fájlformátum, amelyet az API-eszközök értenek.

Segítség az MI-től

Az alkalmazás API-jának legegyszerűbb használata, ha egy MI-kódolóasszisztensre bízza a kód megírását. A Másolás LLM-hez az MI-eszközök számára érthető formátumban másolja ki az alkalmazás teljes API-referenciáját, így az általa írt kód illeszkedik az alkalmazásához. Kód íratása MI-asszisztenssel az alkalmazás API-jához:
  1. Kattintson az alkalmazásszerkesztőben az Irányítópult elemre.
  2. Kattintson az API elemre.
  3. Kattintson a Másolás LLM-hez gombra.
  4. Illessze be az MI-kódolóasszisztensbe, majd írja le, mit szeretne építeni. Például:
  5. Ha a kód elkészült, kattintson az API oldalon a Hozzáférési token létrehozása gombra, és adja meg a tokent ott, ahol a kód kéri.
A hozzáférési token hozzáférést ad az alkalmazás adataihoz. Tartsa titokban: ne illessze be MI-csevegésbe, megosztott dokumentumba vagy képernyőképbe. Ha egy token kiszivárog, törölje, és hozzon létre újat.

Az OpenAPI-specifikáció letöltése

Töltse le az alkalmazás API-referenciáját OpenAPI-fájlként, hogy API-kliensben vagy dokumentációs eszközben használhassa. Az OpenAPI-specifikáció letöltése:
  1. Kattintson az alkalmazásszerkesztőben az Irányítópult elemre.
  2. Kattintson az API elemre.
  3. Kattintson a További műveletek ikonra .
  4. Kattintson az OpenAPI-specifikáció letöltése lehetőségre.
Az API oldal az alkalmazást a megnyitáskori állapotában mutatja. Ha táblákat, backend-függvényeket vagy ügynököket ad hozzá vagy módosít, frissítse az oldalt, hogy a változás megjelenjen a referenciában és az exportált fájlokban.

Webhookok fogadása

A webhook olyan üzenet, amelyet egy másik szolgáltatás küld az alkalmazásnak, amikor valami történik. A Stripe így jelezheti például, hogy egy fizetés sikeres volt. Webhookok fogadásához megadja a szolgáltatásnak az alkalmazás egyik backend-függvényének URL-jét, és a függvény minden üzenet érkezésekor lefut. A Base44 beépített fizetéseihez nem kell webhookokat beállítania. Ha a Stripe-ot az MI-csevegésből állítja be, az regisztrálja a Stripe webhookját, és menti az aláírási titkos kulcsot, amikor a fizetési folyamatnak szüksége van rá. További információ: A Stripe beállítása. Minden backend-függvénynek saját nyilvános URL-je van, ebben a formátumban:
A függvény neve a Kód részben, a base44/functions alatti mappájának neve. Itt az alkalmazás base44.app címét használja, akkor is, ha egyéni domaint csatlakoztatott. A szolgáltatások bejelentkezés nélkül küldik a webhookokat, így a függvény nem támaszkodhat bejelentkezett felhasználóra. Bárki meghívhatja, akinek megvan az URL, ezért a függvénynek minden művelet előtt ellenőriznie kell az üzenet aláírását. A függvény megkapja az eredeti kéréstörzset és fejléceket, amelyekre a legtöbb szolgáltatásnak, köztük a Stripe-nak is szüksége van ehhez az ellenőrzéshez. Webhookok fogadása egy szolgáltatástól:
  1. Kérje meg az alkalmazásszerkesztő MI-csevegését, hogy hozzon létre egy függvényt a webhookhoz, és nevezze meg, mely eseményeket kell kezelnie. Például:
  2. Másolja ki a függvény URL-jét. Az MI-csevegés megadja, vagy a fenti formátum alapján összeállíthatja.
  3. Adja hozzá az URL-t webhook-végpontként a szolgáltatás irányítópultján, és válassza ki ugyanazokat az eseményeket. A Stripe esetén lásd: Stripe webhooks guide.
  4. Másolja ki a szolgáltatás által a végponthoz mutatott aláírási titkos kulcsot.
  5. Adja hozzá az alkalmazáshoz titkos adatként azon a néven, amelyet a függvény vár, például STRIPE_WEBHOOK_SECRET.
Ha végzett, tegye közzé az alkalmazást. A webhookok mindig a közzétett alkalmazás függvényverzióját futtatják, a legutóbbi közzétételkor érvényes titkos adatokkal, ezért bármelyik módosítása után tegye közzé újra.

Webhookok hibaelhárítása

A legtöbb webhookprobléma a függvény titkos kulcsából, a bejelentkezési ellenőrzéseiből vagy egy még közzé nem tett alkalmazásból ered. Ha a webhookok nem érik el a függvényt, keresse meg alább a helyzetét.
A Base44 a függvény futása előtt minden Stripe-webhookot összevet az alkalmazásban mentett Stripe aláírási titkos kulcsokkal. Elutasítja a kérést, ha nincs mentett aláírási titkos kulcs, vagy ha egyik sem egyezik.Adja hozzá ennek a végpontnak az aláírási titkos kulcsát titkos adatként az alkalmazáshoz, majd tegye közzé az alkalmazást. Minden Stripe-végpontnak saját, whsec_ előtaggal kezdődő aláírási titkos kulcsa van, és a teszt- és éles végpontoké eltér.
A függvény bejelentkezett felhasználót vagy API-kulcsot ellenőriz, amelyet a webhookokat küldő szolgáltatások nem tudnak biztosítani. Kérje meg az MI-csevegést, hogy módosítsa a függvényt úgy, hogy ne igényeljen bejelentkezést, hanem helyette a webhook aláírását ellenőrizze.További információ: backend-függvények hibaelhárítása.
A webhookok csak a közzétett alkalmazás függvényeit érik el. Ellenőrizze, hogy az URL pontosan a függvény nevét használja-e, majd tegye közzé az alkalmazást, hogy a függvény legújabb verziója éles legyen.
Ha a webhookok továbbra sem működnek, forduljon a Customer Care csapatához. Adja meg az alkalmazás hivatkozását, a függvény nevét és a webhookokat küldő szolgáltatást.

További lehetőségek

Ha fejlesztő, a fejlesztői dokumentáció részletesen ismerteti az alkalmazás API-ját és a Base44 SDK-t.

A Base44 SDK áttekintése

Állítsa be az SDK-t, és ismerje meg, hogyan működik az alkalmazásával.

Munka az adatokkal

Rekordok olvasása, létrehozása, frissítése és törlése az alkalmazás tábláiban kódból.

Entitások

Az alkalmazás API-ja mögötti táblák definiálása és védelme.

Személyes hozzáférési tokenek

A szkriptek és eszközök bejelentkezéséhez használt tokenek létrehozása és kezelése.
Ezt az oldalt MI segítségével fordítottuk. A legpontosabb és legfrissebb információkért tekintse meg az angol nyelvű változatot.