Az API az a szerződés, amely leírja, milyen kérésre milyen választ ad egy rendszer. Nem a felhasználónak szól, hanem a másik programnak: a webáruház így kér árfolyamot, így küld számlaadatot, így kap csomagkövetési számot.
REST és JSON
A weben a leggyakoribb forma a REST: a kérés egy szokásos webcím, a válasz pedig JSON, vagyis ember számára is olvasható adatszerkezet. Ezért lehet egy integrációt böngészőből vagy egyszerű eszközökkel is kipróbálni.
Amire integrációnál figyelni kell
- Kulcskezelés: az API-kulcs a szerveren marad, soha nem kerül a böngészőbe
- Korlátok: a legtöbb szolgáltatás percenkénti kéréskorlátot ad, ezt ki kell várni, nem megkerülni
- Hibatűrés: ha a másik rendszer nem válaszol, a folyamat ne álljon meg: újrapróbálás és értesítés kell
- Naplózás: vita esetén az menti meg a helyzetet, hogy pontosan mit küldtünk és mit kaptunk