API-integráció fenntartása: mi történik az első sikeres adatküldés után?

Egy API-integráció bemutatóján gyakran egy sikeres adatküldés látszik. Élesben viszont a külső rendszer átmenetileg nem válaszolhat, változhat egy mező, lejárhat a hozzáférés vagy újra érkezhet ugyanaz a feladat. Az integráció valódi értékét az adja, hogyan viselkedik ezekben a helyzetekben.

Határozd meg a kapcsolat felelősségét

Először döntsd el, melyik rendszer az adat forrása, mikor indul a küldés, és mi alapján tekinthető sikeresnek. Egy számla létrehozásánál például nem elég az, hogy a kérés elment: a létrejött bizonylat azonosítóját a saját folyamathoz is kapcsolni kell.

A hibakezelés az ajánlat része legyen

• Időtúllépés: nem biztos, hogy a másik rendszer nem dolgozta fel a kérést.
• Ismétlés: ugyanaz a feladat ne hozzon létre újabb rendelést vagy bizonylatot.
• Korlátozás: a szolgáltató kérési limitjéhez alkalmazkodni kell.
• Hibás adat: az érintett rekord és javítási ok legyen visszakereshető.
• Hozzáférés: a lejáró vagy visszavont kulcs ne maradjon észrevétlen.

A felhasználó számára is legyen világos, hogy egy tétel elküldésre vár, feldolgozás alatt áll, sikeres vagy javításra szorul. Az általános „hiba történt” üzenet nem segíti a napi ügyintézést.

Mi történik szolgáltatói változáskor?

Az API verziója, előfizetési feltétele vagy az elérhető mezők köre idővel változhat. A kapcsolatnak legyen gazdája: ki figyeli az értesítéseket, ki teszteli az új verziót és ki frissíti az integrációt? Az egyszeri fejlesztés nem jelent automatikusan korlátlan, későbbi karbantartást.

Kérj dokumentációt az adatmezőkről, környezetekről és újrapróbálásról. A teszt- és éles kulcsok legyenek elkülönítve. Naplózáskor ne tároljatok fölöslegesen titkos kulcsot vagy teljes ügyféladatcsomagot.

Üzleti próba a technikai próba mellett

Vegyetek végig egy módosított és egy törölt rendelést is, ne csak az új rekordot. Készíts tervet arra, ki és hogyan egyezteti a két rendszer közötti eltéréseket. A működési felelősség tisztázása gyakran fontosabb, mint az első adatküldés sebessége.

Példát a webshopos készletkapcsolat ad; fizetésnél a webhookok külön ellenőrzést igényelnek.