Partnerek kérik az adatot, ti meg exportáltok
Minden hónapban valaki kézzel készít egy fájlt, aztán elküldi e-mailben, és javítja ha hibás.
SZOFTVERFEJLESZTÉS
API fejlesztés, hogy a rendszereid beszéljenek
Dokumentált, verziózott kapcsolat, amire más fejlesztő is rá tud építeni.
Amit építünk
Az API a dokumentációval együtt kész
Egy nem dokumentált API technikailag működik, gyakorlatilag használhatatlan.
RESTMegbízhatóságÁtadás
- REST API végpontok
- Autentikáció és kulcskezelés
- Jogosultsági szintek
- Kérésszám-korlátozás
- Hibakódok és üzenetek
- Verziózás
- OpenAPI dokumentáció
- Teszt-környezet
- Naplózás és monitorozás
Az API fejlesztésnél a végpontok megírása a könnyebb rész. A nehezebb az, ami körülötte van: hogyan azonosítja magát a hívó fél, mi történik hibás kérés esetén, és mi lesz akkor, ha később változtatni kell egy mezőn. Ezért nálunk minden API-hoz verziózás tartozik, hogy egy későbbi módosítás ne törje el azt, ami ma működik. A dokumentációt OpenAPI leírásban adjuk át, ami nem szöveges leírás, hanem gépi formátum: ebből bármely fejlesztő azonnal tud tesztelni. A kérésszám-korlátozás és a naplózás alapból része a munkának, nem külön tétel.
Három tipikus ügyfélhelyzet
Van API, de senki nem érti hogyan működik
A dokumentáció egy elavult Word fájl, és minden integráció kérdezősködéssel kezdődik.
Egy módosítás eltört mindent
Változott egy mező neve, és három partner-integráció állt le egyszerre, mert nincs verziózás.
Végpont-tervezés
Végigvesszük mit kell tudnia, mielőtt bármit megírnánk.
Autentikáció
Kulcs vagy token alapú azonosítás, jogosultsági szintekkel.
Verziózás
A későbbi módosítás nem töri el azt, ami ma működik.
OpenAPI dokumentáció
Gépi formátum, amiből bármely fejlesztő azonnal tud tesztelni.
Teszt-környezet
Külön sandbox, ahol a partner éles adat nélkül próbálhat.
Monitorozás
Naplózás és riasztás, hogy lásd ki mit hív és mikor hibázik.
[Helykitöltő] Ide kerül az ügyfél visszajelzése.
[Helykitöltő] név, pozíció
1/1—[Projekt neve]
[VÉGPONT-SZÁM]Végpontok száma
Valós mérőszám kell ide.
[HÍVÁS/NAP]Napi hívásszám
Valós mérőszám kell ide.
[RENDELKEZÉSRE ÁLLÁS]Rendelkezésre állás
Valós mérőszám kell ide.
Hogyan dolgozunk
Tervezés, építés, átadás
Tervezés
Végigvesszük mit hív a másik fél, és milyen adatot vár.
Építés teszt-környezettel
A partner már fejlesztés közben próbálhat.
Átadás dokumentációval
OpenAPI leírás, teszt-példák, verziószám.
Gyakori kérdések
Amit az API fejlesztés előtt érdemes tudni
Amit másképp csinálunk
RendszerintegrációVissza az áttekintéshez: integráljunk vagy cseréljünk?Rendszerintegráció
Egyedi webalkalmazásokHa a kapcsolat mellé saját rendszer is kell.Egyedi webalkalmazások
AlkalmazásfejlesztésMobilalkalmazás backendjéhez is API kell.Alkalmazásfejlesztés
Kezdjük el