API og integrationer - det grundlæggende

Mål: Forbind Gluu til analyser, RPA og andre systemer via vores REST API, med klar vejledning om tokens, skema, klassetyper og sagsforløbsendpoints.

Du kan bruge API’et til Power BI, dataanalyse eller integrationer med RPA-værktøjer.

Før du går i gang #

Plan: REST API’et og webhooks kræver tilføjelsen API og integrationer. Det er ikke inkluderet i Core-, Essential- eller Advanced-planen i sig selv.
Rolle: Du skal have adgang som Kontoejer/Admin (Administrer konto) for at generere et API-token eller konfigurere webhooks.
Opsætning: Ingen særlig opsætning – generér et token fra Kontoindstillinger, når tilføjelsen er aktiveret.

Få et API-token #

Gå til kontoindstillinger > apps & Integration > API-integration.
Klik på Indstillinger for at generere autorisationstokenet. (Kontoejer/Administrator påkrævet.)
Opbevar tokenet sikkert.

Indstillingspanel for API-integration til generering af et autorisationstoken

Brug skrivebeskyttede tokens til læsning. Til skrivning skal du oprette et personificeret token, så ændringer logges som den bruger.

Du er færdig, når du har et token, der er opbevaret sikkert og klar til brug i dine forespørgsler.

Åben API-specifikation #

Gennemse API’et her: api.gluu.biz/api-browser

Gluu API-browser, der viser tilgængelige endpoints

Skemagrundlag #

Al adgang er over HTTPS fra https://api.gluu.biz. Anmodninger/Svar er i JSON. Tidsstempler er i UTC, ISO 8601:

ÅÅÅÅ-MM-DDTTT:MM:SSZ

Enheder inkluderer en klasse og id:

{
  "_class": "component",
  "_id": "custcomp-3067881d-72fd-41f4-8123-2ef1ec827f9c",
  "prop1": "..."
}

Reducer datamængden ved at filtrere til specifikke klasser, du har brug for.

Klassetyper #

/data forespørgsler returnerer arrays, hvor hvert objekt har en _type, f.eks.:

kategori
group
Proces
aktivitet
formular
formularversion
formulardata
opgave
sagsforløb
bruger
forslag

Hierarki af klassetyper #

Understand forældre/barn-relationer for at planlægge forespørgsler og joins.

Diagram, der viser forældre-/barn-hierarkiet for Gluu API-klassetyper

Oversigt over sagsforløbs-API #

Sagsforløb er menneskestyrede. Du kan starte og spore dem via API og reagere på begivenheder med webhooks.

Start et sagsforløb #

Brug dette endpoint til at starte et sagsforløb fra en skabelon: API: start sagsforløb.

Webhooks #

Udløsere: Fuldført sagsforløbsopgave, Fuldført planlagt opgave.
Konfigurer under Administrer konto > Apps og integrationer > Webhooks.
Begivenheder leveres én gang. EventId er unik. Payload indeholder ID’er (ikke udvidet data).
Efter modtagelse af en begivenhed, slå detaljer op, f.eks. opgaveopslagsAPI.

Fuldfør en opgave #

Du kan programmatisk fuldføre en opgave på samme måde som at indsende den i Gluu. Indsendelse af formulardata via API understøttes ikke – formularer bør udfyldes af brugere.

FAQ – grundlæggende om API og integrationer #

Hvilken plan eller tilføjelse skal jeg bruge for at bruge Gluu API’et?

REST API’et og webhooks kræver tilføjelsen API og integrationer. Det er ikke inkluderet i Core-, Essential- eller Advanced-planen i sig selv.

Hvem kan generere et API-token?

Kun en Kontoejer eller Administrator med adgang til Administrer konto kan generere autorisationstokenet under Kontoindstillinger > Apps & Integration > API-integration.

Hvad er forskellen på et skrivebeskyttet token og et personificeret token?

Brug et skrivebeskyttet token til læseforespørgsler. Til skriveforespørgsler skal du i stedet oprette et personificeret token, så alle ændringer, API’et foretager, logges i Gluu som foretaget af den bruger.

Kan jeg indsende formulardata via API’et?

Nej. Indsendelse af formulardata via API understøttes ikke. Formularer skal udfyldes af brugere direkte i Gluu; API’et kan fuldføre en opgave på samme måde, som en bruger indsender den, men kan ikke udfylde formularfelter.

Hvordan fungerer webhooks i Gluu?

Webhooks udløses af triggere som en fuldført sagsforløbsopgave eller en fuldført planlagt opgave. Konfigurer dem under Administrer konto > Apps og integrationer > Webhooks. Hver begivenhed leveres én gang med en unik EventId, og payload indeholder ID’er frem for udvidet data – slå detaljer op med et efterfølgende API-kald.