Bevezetés az API-kba

Üdvözöljük az API-k nagyszerű világában!

Ebből a cikkből megtudhatja:* Mi az API* Mi a RESTful API* Hogyan dolgozzon a Tulip API-ival?

Mi az az API?

Az API (Application Programming Interface, azaz alkalmazásprogramozási interfész) olyan protokollok összessége, amelyek lehetővé teszik a különböző szoftverkomponensek számára a kommunikációt és az adatátvitelt.

A fejlesztők az API-kat arra használják, hogy áthidalják a kis, különálló kódrészletek közötti szakadékokat, hogy olyan alkalmazásokat hozzanak létre, amelyek nagy teljesítményűek, rugalmasak, biztonságosak és képesek megfelelni a felhasználói igényeknek.

Az API négy kulcsfontosságú részből áll:1. API-ügyfél - hogyan kezdeményezhet API-kérést.2. API-kérelem - az API-nak egy művelet elvégzésére vagy információk visszaadására irányuló kérés.3. API-kiszolgáló - megerősíti, honnan érkezik a kérés, jól formázott-e a kérés, és lekérdezi vagy kezeli a kért adatokat.4. API-válasz - az Önnek (az ügyfélnek) visszajelzett válasz.

API-kérelem

Egy API-kérelem öt fő részből áll:

• Végpont: Ez egy dedikált URL, amely hozzáférést biztosít egy adott erőforráshoz. Például a /tables végpont lehetővé teszi az összes Tulip táblázat lekérdezését vagy egy új Tulip táblázat létrehozását.
• Módszer: Ez az a művelettípus, amelyet az API-val szeretne elvégeztetni. Mivel a Tulip REST API-kat használ, ezek csak a GET, PUT, POST és DELETE lehetőségekre korlátozódnak.
• Paraméterek: Az API végpontnak átadott változók, amelyek az API számára konkrét utasításokat adnak a feldolgozáshoz. A /tables végpont korábbi példáit kibővítve, a /tables/{tableId} segítségével megadhat egy adott táblázat azonosítóját. Ezenkívül vannak olyan lekérdezések, amelyekkel tovább módosíthatjuk a paramétereket.
• Kérés fejlécek: Kulcs-érték párok, amelyek részleteket adnak meg a kérésről, például a tartalom típusát vagy a hitelesítési hitelesítő adatokat.
• Kérelem teste: A kérés fő része, amely részletezi, hogy milyen adatokra van szükség egy erőforrás létrehozásához, frissítéséhez vagy törléséhez. Az Állomások URL-címében például új Állomást kreálhat, és részletezheti, hogy milyen Állomáscsoport része legyen, és milyen alkalmazásokat tartalmazhat.

API-válasz

Ha sikeresen összeállított és elküldött egy REST-kérést, a szerverek a következővel válaszolnak:

• Egy státuszkóddal: Háromjegyű kódok, amelyek az API-kérés eredményét jelzik.
• Válaszfejlécek: További információkat nyújtanak a kiszolgáló válaszáról.
• Választest: A választest tartalmazza az ügyfél által kért tényleges adatokat vagy tartalmat - vagy egy hibaüzenetet, ha valami rosszul sikerült.

Az általános HTTP státuszkódok a következők:

200 OK: Azt jelzi, hogy a kérés sikeres volt, és a válasz teste tartalmazza a kért erőforrást**. 404 Not Found**: Azt jelzi, hogy a kiszolgáló nem találja a kért erőforrást, gyakran egy rosszul beírt URL vagy egy áthelyezett vagy törölt erőforrás miatt**.400 Bad Request**: Azt jelzi, hogy a kiszolgáló nem tudja feldolgozni a kérést az ügyfél hibája miatt, például érvénytelen szintaxis vagy a kérésből hiányzó szükséges paraméterek miatt**.500 Internal Server Error**: Jelzi, hogy a kiszolgáló olyan váratlan körülménybe ütközött, amely megakadályozta a kérés teljesítésében, általában az ügyfél által nem befolyásolható szerveroldali probléma**.302 Found (Moved Temporarily): Azt jelzi, hogy a kért erőforrás ideiglenesen átkerült egy másik URL-címre. Az ügyfélnek újabb kérést kell indítania a válaszfejlécben megadott új URL-címre.401 Unauthorized**: Azt jelzi, hogy a kérés felhasználói hitelesítést igényel, de az ügyfél nem adott meg érvényes hitelesítő adatokat, vagy még nem hitelesítette magát.

A HTTP hibakódokról bővebben itt olvashat.

Mi az a RESTful API?

A Tulip RESTful API-kat használ. Az API-k egyéb típusai közé tartozik a SOAP, a GraphQL, a Webbhooks vagy a gRPC.

A REST API, más néven RESTful API egy egyszerű, egységes interfész, amelyet arra használnak, hogy adatokat, tartalmakat, algoritmusokat, médiát és más digitális erőforrásokat tegyenek elérhetővé webes URL-eken keresztül. A REST API-k ma a leggyakrabban használt API-k a weben.

A REST API-k négy kulcsfontosságú módszert használnak:1. GET: Ez a módszer lehetővé teszi, hogy a szerver megtalálja a kért adatokat, és visszaküldje Önnek.2. PUT: Ha PUT-kérést hajt végre, akkor a szerver frissít egy bejegyzést az adatbázisban.3. POST: Ez a módszer lehetővé teszi, hogy a kiszolgáló új bejegyzést hozzon létre az adatbázisban.4. DELETE: Ez a módszer lehetővé teszi, hogy a kiszolgáló töröljön egy bejegyzést az adatbázisban.

Hogyan dolgozzon a Tulip API-val

Olvassa el a következő cikkeket, hogy elkezdhesse használni és tesztelni az API-kat a Tulip segítségével:

• Mik azok a csatlakozók?
• Hogyan hozzunk létre és konfiguráljunk egy HTTP-konnektor funkciót?
• Egy Tulip API beállítása

Megtalálta, amit keresett?

A community.tulip.co oldalon is megteheti, hogy felteszi kérdését, vagy megnézheti, hogy mások is szembesültek-e hasonló kérdéssel!