Opsæt API-adgang
Firmaets API-område lader brugere med rollen Admin oprette API-nøgler og OAuth-klienter, så eksterne systemer, scripts eller interne værktøjer kan kalde CxPlanner over HTTPS. Det bruges til integrationer, der skal have læse-, skrive- eller global projektadgang.
Se Tilføj en API-bruger til et projekt, når API-brugeren skal knyttes til et projekt.
- Din rolle skal være virksomheds-Admin.
- Du finder menuen ved profilikonet, Firmaprofil, API.
- Her opretter eller tilbagekalder du legitimationsoplysninger, der kan tilgå firma- og projektdata.
Hemmeligheder vises kun én gang. Integrationer, der ikke er globale, kræver, at API-brugeren er medlem af projektet. Global adgang dækker alle firmaets projekter uden opsætning pr. projekt.
Sådan opsætter du API-adgang
Åbn siden med API-nøgler
- Log ind i CxPlanner, og klik på dit profilikon.
- Gå til Firmaprofil.
- Klik på API.
Opret en ny API-nøgle eller OAuth-klient
- Klik på Generer API-nøgle nederst på skærmen.
- I Create new API key skriver du API-navn.
- Vælg API type.
- Vælg API scope.
- Klik på Gem.
Gem legitimationsoplysningerne sikkert
- Se, hvilken type der blev oprettet.
- Ved en statisk API-nøgle kopierer du hemmeligheden fra dialogen.
- Ved OAuth-typer kopierer du Client ID og Client Secret.
- Gem dem i jeres hemmelighedsstyring, før du lukker dialogen.
Administrer eksisterende legitimationsoplysninger
- Åbn tabellen på siden med API-nøgler.
- Gennemgå Navn, Omfang, Type, Sidst brugt og Brugt (antal).
- Find den nøgle eller klient, der skal fjernes.
- Klik på Slet.
- Bekræft i dialogen Delete API key.
Giv projektadgang til API-brugere med begrænset omfang
- Bekræft, at integrationen bruger et omfang, der ikke er globalt.
- Find API-brugeren (`apiservice+<unique_id>@cxplanner.com`).
- Åbn hvert relevant projekt.
- Tilføj API-brugeren med en passende projektrolle.
- Vælg en rolle, der matcher det, integrationen skal kunne.
Resultat: API-adgang
Godkendelsestyper
Godkendelsestype | Anvendelse | Sådan virker den | Typisk brug |
|---|---|---|---|
Statisk API-nøgle | System til system | Send nøglen i headeren | Enkle integrationer |
OAuth (API-bruger) | System til system | Brug client_id og client_secret til at hente Bearer-tokens (client_credentials) | Almindelige sikre integrationer |
OAuth PKCE (individuel bruger) | Delegeret af en bruger | Brugeren logger ind og godkender adgangen, og API'en bruger derefter et Bearer-token | Integrationer på vegne af en bruger |
Omfang
Omfang (opret-dialog) | Etiket i tabellen | Adgang |
|---|---|---|
Developer READ API | READ ONLY | Kun læseadgang |
Developer READ-WRITE API | READ & WRITE | Læse- og skriveadgang |
Developer Global API | GLOBAL | Adgang til alle firmaets projekter |
Regler for projektadgang
Omfangstype | Projektadgang kræves | Resultat |
|---|---|---|
READ API | Ja | Kan læse data i de tildelte projekter |
READ-WRITE API | Ja | Kan læse og skrive i de tildelte projekter |
GLOBAL | Nej | Adgang til alle firmaets projekter |
Statiske API-nøgler udløber ikke. Bearer-tokens holder i omkring 3600 sekunder og har et refresh-token. |
Fejlfinding: opsæt API-adgang
Problem | Årsag | Løsning |
|---|---|---|
Menuen API mangler | API-modulet er ikke slået til, eller rollen er under Admin | Bed en virksomheds-Admin om at slå modulet med API-nøgler til, eller om at hæve din rolle til Admin |
Generer API-nøgle kan ikke klikkes | API-funktionen er ikke slået til for firmaet | Bed en virksomheds-Admin eller CxPlanner Support om at slå modulet med API-nøgler til |
Fejl ved åbning af API-siden | Kontoen er ikke virksomheds-Admin | Log ind med en konto, der er virksomheds-Admin |
Integrationen kan ikke tilgå et projekt | API-brugeren er ikke tilføjet, eller omfanget er forkert | Tilføj API-brugeren til projektet, og bekræft nøglens omfang |
API-hemmeligheden er væk | Hemmeligheder vises kun én gang | Opret en ny nøgle, opdater integrationerne, og slet den gamle nøgle |
Integrationen kan ikke skrive data | Der er valgt et omfang med kun læsning | Opret en nøgle med omfanget Developer READ-WRITE API |
Integrationen kan ikke tilgå alle projekter | Der bruges ikke globalt omfang | Opret en nøgle med omfanget Developer Global API, eller tilføj API-brugeren til hvert projekt |
Opdateret den: 30/10/2026
Tak!