Webhook-urile, API-urile de tip cerere-răspuns și interogarea periodică sunt trei modalități de conectare a sistemelor. Fiecare model transferă informațiile în mod diferit. Alegeți un model în funcție de cât de repede trebuie să ajungă datele, de cât control necesită integrarea, de modul în care ar trebui să se recupereze în urma unor erori și de cât trafic va genera.
Cuprins
Care este diferența dintre webhooks, API-uri și polling?
| Model | Cum funcționează | Cea mai potrivită opțiune |
|---|---|---|
| API de tip cerere-răspuns | Sistemul dvs. trimite o cerere și așteaptă un răspuns. | Preluarea datelor sau inițierea unei acțiuni atunci când aplicația dvs. are nevoie de acestea. |
| Webhook | Un sistem trimite un eveniment către un alt sistem atunci când are loc o modificare. | Transmiterea rapidă a evenimentelor fără verificări repetate ale stării. |
| Polling | Sistemul dvs. trimite solicitări la intervale prestabilite pentru a verifica dacă există un nou statut sau rezultat. | Verificări programate, integrări simple și recuperare atunci când livrarea evenimentelor nu este disponibilă. |
Aceste modele pot funcționa și împreună. Un webhook poate notifica aplicația dvs. că a avut loc un eveniment, în timp ce o solicitare API preia înregistrarea completă. Pollingul poate acționa apoi ca soluție de rezervă dacă notificarea așteptată nu sosește. Comparațiile dintre aceste modele se concentrează de obicei pe latență, recuperare și moduri de eșec, mai degrabă decât doar pe definiții. ASOasis le descrie ca fiind factori-cheie de proiectare.
Când ar trebui să utilizați un API de tip cerere-răspuns?
Utilizați o API de tip cerere-răspuns atunci când aplicația dvs. controlează sincronizarea interacțiunii. Aplicația trimite o cerere, primește un răspuns și poate utiliza imediat acel răspuns în fluxul de lucru curent.
Acest model se potrivește pentru acțiuni precum încărcarea informațiilor la deschiderea unei pagini, trimiterea unui formular, crearea unui înregistrare sau solicitarea stării curente a unei operațiuni. Este util și atunci când o notificare de eveniment nu ar oferi suficiente informații, iar aplicația trebuie să solicite direct cele mai recente date.
Principalul avantaj operațional este controlul. Aplicația dvs. decide când să trimită solicitarea și poate gestiona răspunsul în cadrul aceluiași flux. Compromisul constă în faptul că aplicația trebuie să efectueze solicitarea exact în momentul în care are nevoie de informații. Dacă acțiunea durează mult timp, primul răspuns poate confirma doar că procesarea a început, astfel încât poate fi necesară o solicitare ulterioară privind starea.
Când ar trebui să utilizați un webhook?
Utilizați un webhook atunci când un sistem trebuie să notifice un alt sistem imediat ce are loc un eveniment relevant. Aplicația destinatară expune un punct final, iar sistemul expeditor transmite un eveniment către acel punct final.
Webhook-urile sunt extrem de potrivite pentru modificările stării plăților, actualizările comenzilor, evenimentele legate de conturi și alte fluxuri de lucru în care așteptarea următoarei verificări programate ar genera întârzieri inutile. Acestea evită verificările repetate atunci când nu s-a schimbat nimic, dar necesită ca punctul de capăt receptor să fie disponibil și pregătit să proceseze evenimentele primite.
Livrarea webhook-urilor trebuie proiectată având în vedere recuperarea în caz de eșec. Expeditorul și destinatarul au nevoie de o abordare clară pentru erorile temporare, livrările repetate și evenimentele care sosesc în ordine greșită. Un handler de webhook ar trebui să proceseze în siguranță același eveniment de mai multe ori sau să utilizeze un identificator de eveniment pentru a preveni acțiunile de afaceri duplicate. Comportamentul de livrare și recuperare reprezintă preocupări centrale în proiectarea webhook-urilor. OrchestriAI discută despre webhook-uri și interogare în legătură cu latența, recuperarea și modurile de eșec.
Când ar trebui să utilizați interogarea?
Utilizați polling-ul atunci când aplicația dvs. poate verifica modificările conform unui program sau când serviciul conectat nu asigură livrarea fiabilă a evenimentelor. Aplicația trimite o solicitare, verifică rezultatul, așteaptă și repetă solicitarea conform programului său de interogare.
Interogarea este mai ușor de înțeles atunci când aplicația are nevoie de o verificare regulată a stării. De asemenea, aceasta oferă sistemului receptor controlul asupra momentului trimiterii solicitărilor. Dezavantajul este că solicitările pot fi trimise chiar și atunci când nu există date noi. Un interval scurt poate crește volumul solicitărilor, în timp ce un interval lung poate întârzia detectarea unei modificări.
Interogarea este utilă și ca cale de recuperare. Un design cu două căi poate utiliza webhook-uri pentru livrarea normală a evenimentelor și interogarea programată pentru a identifica stările care nu au fost primite prin calea webhook-ului. Acest model de rezervă, care combină webhook-urile și interogarea programată, este descris în cercetările privind canalele de mesagerie de ieșire. Consultați arhitectura de verificare cu două căi pe arXiv.
Cum se compară modelele din punct de vedere operațional?
| Factor de decizie | API de tip cerere-răspuns | Webhook | Interogare |
|---|---|---|---|
| Viteza de livrare | Imediat după ce aplicația dvs. trimite cererea. | De obicei, cea mai rapidă opțiune pentru notificarea evenimentelor, deoarece livrarea începe după eveniment. | Depinde de intervalul de interogare. |
| Complexitatea implementării | De obicei, directă pentru o singură solicitare și un singur răspuns. | Necesită un punct final și procesarea evenimentelor. | Necesită programare, solicitări repetate și gestionarea stării. |
| Modelul de trafic | Traficul urmează acțiunile utilizatorului sau ale aplicației. | Traficul urmează evenimentele. | Traficul continuă conform programului, inclusiv verificările fără modificări. |
| Recuperarea în caz de eșec | Se reîncearcă solicitarea sau se solicită din nou starea curentă. | Necesită gestionarea reîncercărilor de livrare și protecție împotriva duplicatelor. | Verificările ulterioare pot descoperi o stare pe care o verificare anterioară a omis-o. |
| Preocupări legate de scalabilitate | Volumul cererilor crește odată cu activitatea aplicației. | Volumul de procesare crește odată cu volumul evenimentelor. | Volumul cererilor crește odată cu numărul de resurse și frecvența interogărilor. |
Ce verificări de securitate se aplică?
Protejați fiecare cale de integrare în funcție de direcția și fluxul de date al acesteia.
- Pentru API-uri, protejați datele de autentificare și limitați fiecare set de date de autentificare la acțiunile necesare integrării.
- Pentru webhook-uri, protejați punctul final de recepție și verificați dacă fiecare cerere primită reprezintă un eveniment așteptat înainte de a aplica o modificare de afaceri.
- Pentru interogare, protejați datele de autentificare utilizate de solicitările programate și împiedicați expunerea datelor de stare prin jurnale sau puncte finale publice.
Pentru toate cele trei tipuri de integrare, nu includeți secretele în codul sursă, înregistrați suficiente informații pentru a urmări eșecurile și separați succesul transportului de succesul operațional. O solicitare poate ajunge la un sistem chiar și atunci când acțiunea dorită necesită încă revizuire sau o nouă încercare.
Ce model de integrare ar trebui să alegeți?
- Alegeți o API de tip cerere-răspuns atunci când aplicația dvs. are nevoie de date sau de o acțiune într-un moment specific al fluxului său de lucru.
- Alegeți un webhook atunci când un serviciu poate trimite notificări de evenimente fiabile și când este important ca întârzierea de livrare să fie redusă.
- Alegeți polling-ul atunci când verificările programate sunt acceptabile, livrarea evenimentelor nu este disponibilă sau aveți nevoie de o cale de recuperare controlată.
- Utilizați un design combinat atunci când evenimentele ratate au un efect semnificativ. Webhook-urile pot oferi notificări rapide, API-urile pot furniza înregistrarea oficială, iar polling-ul poate verifica sau recupera starea finală.
Cea mai fiabilă alegere se bazează adesea pe fluxul de lucru, mai degrabă decât pe un singur model. Începeți cu viteza de livrare necesară, apoi definiți modul în care integrarea detectează evenimentele ratate, repetă operațiunile în siguranță și recuperează starea curentă după o eroare.