Integrationer og API: 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.

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

Før I går i gang #

Plan: REST API’et og webhooks kræver tilføjelsen Integrationer og API. Det er ikke inkluderet i Core-, Essential- eller Advanced-planen i sig selv.
Rolle: I skal have adgang som Kontoejer/Administrator (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 I oprette et personificeret token, så ændringer logges som den bruger.

I er færdige, når I har et token, der er opbevaret sikkert og klar til brug i jeres forespørgsler.

OpenAPI-specifikation #

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

Gluu API-browser, der viser tilgængelige endpoints

Grundlæggende om skemaet #

Al adgang foregår via HTTPS fra https://api.gluu.biz. Forespørgsler og svar er i JSON. Tidsstempler er i UTC og følger ISO 8601:

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

Entiteter indeholder en klasse og et id:

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

Reducer datamængden ved at filtrere på de klasser, I har brug for.

Klassetyper #

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

category
group
process
activity
form
formversion
formdata
task
caseworkflow
user
suggestion

Hierarki af klassetyper #

Forstå forælder/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. I kan starte og spore dem via API og reagere på hændelser med webhooks.

Start et sagsforløb #

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

Webhooks #

Udløsere: Fuldført sagsforløbsopgave, Fuldført planlagt opgave.
Konfigurer under Administrer konto > Apps og integrationer > Webhooks.
Hændelser leveres én gang. EventId er unik. Payload indeholder ID’er (ikke udvidede data).
Når I har modtaget en hændelse, kan I slå detaljer op, f.eks. via opgaveopslags-API’et.

Fuldfør en opgave #

I 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 kræves der for at bruge Gluu API’et?

REST API’et og webhooks kræver tilføjelsen Integrationer og API. 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 I 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 hændelse leveres én gang med et unikt EventId, og payload indeholder ID’er frem for udvidede data. Slå detaljer op med et efterfølgende API-kald.