Konfiguračná príručka CORS pre rozhrania Webhook API v nástroji API Designer

Zdieľanie zdrojov medzi rôznymi zdrojmi (CORS) je bezpečnostný mechanizmus prehliadača, ktorý obmedzuje webové stránky v odosielaní požiadaviek na inú doménu, ako je tá, ktorá webovú stránku poskytla. Toto sa robí s cieľom chrániť používateľov pred škodlivými webovými stránkami, ktoré sa pokúšajú získať prístup k citlivým údajom z inej stránky bez povolenia.

Prehľad

Návrhár API od spoločnosti Vtiger bol vytvorený ako výkonný nástroj, ktorý slúži ako pracovný stôl pre vývojárov na jednoduché vytváranie vlastných API založených na HTTP. Tieto API je možné bezproblémovo integrovať s JavaScriptovými API od VTAP alebo externými aplikáciami.

Do návrhára API sme pridali funkciu na určenie povolených domén (domén, ktoré je možné pridať na bielu listinu). Iba tieto domény na bielej listine budú môcť odosielať požiadavky CORS.

Dozvieme sa viac o CORS a jeho aplikácii.

Objektívne

Hlavné ciele umožnenia CORS:

  • Umožnite bezpečnú komunikáciu medzi frontendovými aplikáciami a CRM systémom naprieč rôznymi zdrojmi.
  • Povoľte volania rozhrania API webhooku z klientskych aplikácií alebo externých portálov.
  • Zabráňte chybám CORS na strane prehliadača.
  • Chráňte dáta CRM pred neoprávnenými doménami.

Technická implementácia

Pri vytváraní rozhrania Webhook API v nástroji API Designer existuje možnosť pridať doménu ku konfigurácii. Táto doména predstavuje pôvod (webovú stránku alebo aplikáciu), ktorá bude odosielať požiadavky alebo prijímať údaje od Vtigeru. 

Po pridaní domény:

  • Vtiger bude povoliť požiadavky z viacerých zdrojov z tej domény.
  • Spustí sa rozhranie API webhooku úspešné prijímanie údajov z CRM systému.
  • Prehliadač zablokuje všetky požiadavky prichádzajúce z domény, ktoré nie sú na bielej listine.

Toto nastavenie zaisťuje, že rozhranie Webhook API môže bezpečne fungovať podľa očakávania bez potreby backendových proxy alebo riešení, pričom si stále zachováva kontrolu nad tým, ktoré domény môžu interagovať s Vtigerom.

Príklad

Ak sa webová aplikácia hostovaná na adrese https://app.example.com pokúsi odoslať požiadavku do API na adrese https://api.vtiger.com, prehliadač požiadavku zablokuje, pokiaľ to API explicitne nepovolí prostredníctvom hlavičiek CORS.

Aby bola táto interakcia možná a bezpečná, server musí odpovedať špeciálnymi hlavičkami (ako napríklad Access-Control-Allow-Origin), ktoré prehliadaču hovoria, ktoré pôvody (domény) k nemu majú povolený prístup.

V prípade Vtigera, čo umožňuje Pridanie na bielu listinu CORS umožňuje dôveryhodným doménam interakciu s CRM (napríklad odosielanie požiadaviek na webhook alebo volanie API) bez toho, aby ich blokoval prehliadač.

Prípad použitia

Máte frontendovú aplikáciu hostovanú na adrese https://portal.mycompany.com, ktorá potrebuje odosielať požiadavky webhook API do vašej inštancie Vtiger CRM na adrese https://crm.mycompany.com.

Problém

Prehliadač blokuje požiadavku z dôvodu chyby CORS: Prístup k načítaniu na adrese „https://crm.mycompany.com/webhook“ z pôvodnej adresy „https://portal.mycompany.com“ bol zablokovaný politikou CORS.

Riešenie Pridajte https://portal.mycompany.com do bielej listiny CORS vo Vtigeri. Potom prehliadač povolí požiadavku, pretože odpoveď bude obsahovať správne hlavičky.

Výhody

  • Zabraňuje zlyhaniam požiadaviek súvisiacim s CORS v aplikáciách frontendu.
  • Umožňuje bezpečný a kontrolovaný prístup k Vtiger API z dôveryhodných domén.
  • Podporuje integráciu s modernými frontendovými frameworkami ako React, Angular, Vue atď.
  • Odstraňuje potrebu backendových proxy serverov na spracovanie komunikácie cez API.
  • Jednoduchá správa a aktualizácia cez administrátorské rozhranie.

Veríme, že tieto príklady zlepšia vaše skúsenosti s Vtiger CRM. Chceme zabezpečiť, aby si vývojári a používatelia CRM mohli vzájomne vymieňať informácie a znalosti na podporu funkčnosti CRM. 

Zostaňte naladení na ďalšie. Šťastné kódovanie!

 
 

Prihláste sa a získajte najnovšie aktualizácie!