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å 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.

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

Åben API-specifikation #

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

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.

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.