API ir MCP nustatymai bei dokumentacija

API ir MCP leidžia saugiai prijungti kitas sistemas bei dirbtinio intelekto įrankius prie jūsų „Hanna“ paskyros. Ši sritis skirta administratoriams ir darbuotojams, kuriems suteikta API bei MCP prieiga.

Kaip atidaryti API ir MCP nustatymus

1. Atidarykite Sistemos nustatymai.
2. Kairiajame meniu pasirinkite API ir MCP.
3. Atsidariusiame puslapyje matysite aktyvius raktus ir prijungimus, jų naudotojus, teises, būseną, galiojimo laiką bei paskutinį naudojimą.

Jeigu skilties nematote, kreipkitės į administratorių. Darbuotojo kortelėje jam turi būti suteikta API ir MCP prieiga. Prieiga prie šios skilties nepakeičia darbuotojo rolės ir nesuteikia papildomų CRM duomenų teisių.

Kur rasti API dokumentaciją

Puslapio viršuje paspauskite API Dokumentacija. Atsidarys jūsų paskyrai pritaikytas API v4 aprašas. Jame galite:

• pasirinkti CRM modulį;
• peržiūrėti galimas paieškos, gavimo, kūrimo, redagavimo ir trynimo operacijas;
• patikrinti užklausų parametrus ir laukų formatus;
• pamatyti atsakymų schemas ir pavyzdžius;
• atsisiųsti OpenAPI aprašą.

Tiesioginis dokumentacijos adresas sudaromas pagal jūsų paskyrą:

https://{jūsų-paskyra}.hannacrm.app/api/docs

API v4 bazinis adresas:

https://{jūsų-paskyra}.hannacrm.app/api/v4

OpenAPI YAML aprašas:

https://{jūsų-paskyra}.hannacrm.app/api/openapi.yaml

Dokumentaciją visada atidarykite savo paskyros domene. Tuomet matysite tai paskyrai aktualius modulius, laukus ir serverio adresą.

Viešame „Hanna“ pagalbos centre taip pat galite naudoti centralizuotą „Hanna CRM API v4“ techninį žinyną. Jame patogu ieškoti endpointų, parametrų, autentifikavimo ir užklausų pavyzdžių. Šiame žinyne pateikiamas default.hannacrm.app bazinis adresas, todėl prieš vykdydami užklausą default pakeiskite savo „Hanna“ paskyros subdomenu. Jei reikia tiksliai matyti konkrečioje paskyroje įjungtus modulius ir laukus, naudokite tos paskyros /api/docs dokumentaciją.

Kur rasti MCP dokumentaciją

Tame pačiame puslapyje paspauskite MCP Dokumentacija. Joje pateikiami MCP klientams skirti įrankiai, jų paskirtis ir parametrai. Tiesioginis adresas:

https://{jūsų-paskyra}.hannacrm.app/mcp/docs

MCP dokumentacijoje aprašomi įrankiai, pavyzdžiui, įrašų paieška, vieno įrašo gavimas, kūrimas ar atnaujinimas. Tai nėra įprasti REST adresai – šiuos veiksmus kviečia MCP klientas.

MCP įrankių YAML aprašas:

https://{jūsų-paskyra}.hannacrm.app/mcp/openapi.yaml

MCP dokumentacija yra atskira nuo pagalbos centro API dokumentacijos skilties. Pastarojoje pateikiamas REST API v4 žinynas, o MCP įrankius visada tikrinkite savo paskyros /mcp/docs puslapyje.

Kuo skiriasi API ir MCP

API v4 naudoja jūsų sukurtą raktą ir tinka sistemų integracijoms, duomenų apsikeitimui bei automatizuotiems procesams.

MCP naudoja OAuth prisijungimą ir leidžia suderinamam MCP klientui matyti bei kviesti „Hanna“ įrankius pagal suteiktas teises.

Abiem atvejais galioja CRM modulių, darbuotojo, rolės ir laukų matomumo taisyklės. Jei laukas ar modulis paskyroje išjungtas, integracija jo taip pat gali nematyti.

Susiję straipsniai

• API rakto kūrimas ir teisių valdymas
• MCP prijungimas ir prieigos valdymas