Mi az API? A jelentése egyszerű szavakkal, egy saját példán
Az API az application programming interface rövidítése, magyarul alkalmazásprogramozási felület. Ezen keresztül kér egy program valamit egy másik programtól, vagy utasítja valamire, anélkül hogy közben egy ember kattintgatna.
Egy példa, amelyet minden munkanap használunk. Amikor az alkatrész-kereskedésünk rendelési rendszere FedEx-címkét foglal, senki nem nyitja meg a fedex.com-ot. A program elküldi a FedEx-nek a címet, a súlyt és a szolgáltatást, a FedEx pedig visszaküldi a címkét és a követési számot. Ez a csere egy API-hívás.
Minden API négy része
Bármelyik API-ról hall, az eBay-étől a bankjáéig, ugyanezekből áll.
- A kérés
- Amit az egyik program kér, abban a formában, amelyet a másik oldal közzétett: „FedEx Priority címke erre a címre, 1,9 kg, egy doboz”.
- A válasz
- Ami visszajön: a címke fájlként és egy követési szám, vagy egy hibaüzenet arról, melyik mező volt rossz.
- A kulcs
- Egy hosszú titkos karaktersor, amellyel egy program a fiókja nevében dolgozhat, a jelszava nélkül. Ha törli a kulcsot, a kapcsolat azonnal megszakad.
- A dokumentáció
- A közzétett lista arról, mit lehet kérni, melyik kéréshez milyen mezők kellenek, és hány kérést küldhet egy program.
Mi az API-integráció
Az integráció két vagy több program összekötése az API-jukon át, úgy, hogy az egyikben történt esemény elindítsa a megfelelő lépéseket a többiben. A listázó alkalmazásunk, az ICE jó példa. Valaki lefotóz egy használt alkatrészt, az ICE elolvassa a típustáblát és megírja a hirdetés vázlatát, az ember pedig beírja az árat, és megnyomja a List gombot.
API-k, amelyekkel a saját szoftvereink beszélnek
Mindegyik a rendelési rendszerünkben, a listázó alkalmazásunkban vagy az általunk épített antikvárium-webshopban fut. Bal oldalt a szolgáltatás, jobb oldalt, hogy mit kér tőle a szoftverünk.
Az antikvárium azt is megmutatta, miért számítanak a részletek. A piactéren egy részleges frissítés kitörli azokat a mezőket, amelyeket kihagy, ezért a bolt mindig a teljes rekordot küldi.
- eBayÖtpercenként behozza az új rendeléseket, élesíti a hirdetéseket, és visszaküldi a követési számot a vevő rendelésére.
- FedExÉlő árak, címke, futárrendelés és elektronikus vámszámla, egyetlen foglalásban.
- Egy magyar csomagküldő közvetítőA GLS, a DPD, az UPS és más futárcégek ára a FedEx mellett, egy bekötésen át.
- Számlázz.huSzámla vevőnként a megfelelő áfasorral; az adatokat a számlázó adja tovább a NAV-nak.
- Az uniós áfa-nyilvántartásA vevő közösségi adószámának ellenőrzése, mielőtt a számlára kerül.
- AbeBooksEgy könyv hirdetésének frissítése vagy levétele, ha ugyanaz a könyv az antikvárium saját boltjában változik vagy elkel.
- Kártyás fizetési szolgáltatóA vevő a szolgáltató oldalán fizet, és egy aláírt üzenet szól a boltnak, hogy a rendelés ki van fizetve.
- Google Merchant CenterTermékfeed minden fotózott könyvről, országonkénti szállítási díjjal.
Ha nincs API
Nem minden rendszernek van, és a hiányzó API tervezési feladat, nem zsákutca. Egy magyarországi napelem-újrahasznosítónál, amelynek üzemi szoftvert építettünk, a papírokat továbbra is az országos hulladéknyilvántartás állítja ki. A szoftver rögzíti a szállítmányt, csatolja a szkenneket, és pontosan azt készíti elő, amit az iroda beírna, így semmit nem kell kétszer begépelni.
Néha a válasz e-mailben érkezik. Ha a FedEx azt írja, hogy egy csomag fennakadt a vámon, a rendelési rendszerünk elolvassa ezt az e-mailt, visszateszi a csomagot a listájára, és kétnaponta újra rákérdez, amíg át nem engedik.
Kérdések az API-ról
Mit jelent az API?
Az angol application programming interface rövidítése, magyarul alkalmazásprogramozási felület. A lényeg a „felület”: ez az a megállapodott mód, ahogyan egy program egy másikhoz fordul, ahogy egy ügyfélszolgálati űrlap az a mód, ahogyan egy ember kér valamit.
Mi az API egyszerűen?
Kérések listája, amelyeket egy program elfogad egy másiktól, és mindegyikre meghatározott választ ad. A rendelési rendszerünk elküldi a FedEx-nek a címet, a súlyt és a szolgáltatást, a FedEx pedig címkével és követési számmal válaszol. Közben senki nem nyit meg weboldalt.
Mi az API-integráció?
Két program összekötése az API-jukon keresztül, hogy az adat magától mozogjon köztük. Amikor a listázó alkalmazásunkból egy alkatrész felkerül az eBay-re, az alkalmazás a rendelési rendszernek is szól, melyik dobozban van. Bővebben: API-integráció.
Mi az a REST API?
A webes API-k leggyakoribb fajtája. Minden, amiről kérdezni lehet (egy rendelés, egy számla, egy hirdetés), saját webcímet kap, és szokásos webes kérésekkel lehet olvasni, létrehozni, módosítani vagy törölni. Az adat többnyire JSON formában utazik, egy egyszerű szöveges formátumban, amelyet mindkét oldal ért.
Kell programozó egy API használatához?
Két népszerű alkalmazás egyszerű összekötéséhez egy kész összekötő, például a Zapier vagy a Make, kód nélkül is elég. Ha a lépéshez a saját szabályai kellenek, vagy a másik oldal nincs a listájukon, valakinek meg kell írnia az integrációt.
Biztonságos egy programnak API-kulcsot adni?
A kulcs bármit megtehet, amit a fiók megenged, ezért úgy kell kezelni, mint egy jelszót: a szerveren tartjuk, sosem egy weboldalban, és töröljük, ha a kapcsolat megszűnik. Mi egy második védelmet is teszünk mellé: a rendelési rendszerünkben csak az éles szerver küldhet bármit a vevőknek, mióta egy tesztpéldány egyszer éles üzeneteket küldött.
Olvasson tovább
- Egyedi szoftverfejlesztésAmit egy eBay-alkatrészkereskedésnek, porfestő műhelyeknek és egy hazai hulladékkezelőnek építettünk, és mennyibe kerül.
- API-integrációeBay, futárcégek, számlázás, fizetés és Google összekötve, hogy senki ne gépeljen át egy rendelést.
- AI-automatizálásMit olvas, sorol be és fogalmaz meg nálunk az AI, és melyik lépés marad mindig emberé.
- Számlázz.hu, Billingo és NAVSzámla begépelés nélkül, a webshopból vagy a rendelési rendszerből.
Kössük össze a programjait
Egy 30 perces hívás. Elmondja, mely programok között másol ma a csapata, mi pedig megmondjuk, megoldható-e az API-jukkal, mit építenénk, és mennyibe kerül.