Så bygger du din första applikation mot DirSys API med hjälp av Claude AI
Guiden visar hur du kommer igång med DirSys Public API utan att först behöva sätta dig in i API:ets alla endpoints och scheman manuellt. I stället låter du Claude Code läsa API:ets OpenAPI-specifikation åt dig och skapa en fungerande applikation utifrån den.
Som genomgående exempel bygger vi en applikation som listar informationsbärare från DirSys Security. Metoden är dock inte specifik för den resursen – samma tillvägagångssätt fungerar lika bra för personuppgiftsbehandlingar i DirSys Integrity och för övriga delar av API:et. Byt ut resursnamnet i prompten i steg 7; i övrigt följer du samma steg.
Du behöver inte ha programmerat tidigare för att följa guiden, men det underlättar om du vet ungefär vilket programmeringsspråk eller vilken typ av applikation (skript, webbsida eller skrivbordsapp) du vill skapa. Om du är osäker kan du be Claude Code om förslag.
En enkel applikation som listar informationsbärare med namn, säkerhetsutrymme och datum för senaste uppdatering. Data hämtas direkt från DirSys API när applikationen körs. Programmeringsspråk och gränssnitt avgörs av vad du skriver i prompten till Claude Code i steg 7.
När du bygger appen behöver du inte arbeta direkt mot DirSys API. Claude Code läser specifikationen och skriver koden. Därefter är det den färdiga applikationen som anropar API:et med din nyckel.
Steg 1–5 Developer Portal Du skapar en API-klient, kopierar nyckeln och laddar ner OpenAPI-specifikationen | → | Steg 6–7 Claude Code Läser OpenAPI-specifikationen och din prompt och skriver applikationen åt dig | → | Resultat DirSys API api.dirsys.app |
Applikationen som Claude Code bygger anropar DirSys API direkt och använder din API-nyckel som Bearer-token. Vad appen får se och göra styrs helt av nyckelns behörigheter (scopes) och vilka säkerhetsutrymmen eller controllers den har åtkomst till – inte av vad du skriver i prompten.
Innan du loggar in kontrollerar du att alternativet API access (Developer portal) är inställt på Yes. Du hittar inställningen under Användaradministration → Roller och behörigheter för den roll som du eller din administratör har tilldelat dig.
Om inställningen redan är aktiverad för din roll kan du hoppa direkt till steg 2. Om du inte själv har behörighet att ändra roller behöver du be en administratör att aktivera den åt dig.
Öppna Developer Portal och ange ditt Organization ID (Tenant ID) i inloggningsrutan.
Du omdirigeras därefter till inloggningssidan för er egen tenant. Ditt Organization ID finns i den information som ni fick när ert DirSys-konto skapades.
Under API Clients skapar du en ny klient. Fyll i ett namn och ta ställning till tre saker: vilka behörigheter (scopes) klienten ska ha, vilken anropsfrekvens den behöver och vilka delar av er data den ska kunna nå.
| Fält | Innebörd |
|---|---|
| Permissions | READ och/eller WRITE. En applikation som bara ska läsa data – som exemplet i den här guiden – behöver enbart READ. |
| Rate Limit | Standard är 100 anrop/minut. Räcker inte det, kontakta support@dirsys.com. |
| Access Restrictions | Unrestricted ger åtkomst till alla säkerhetsutrymmen och controllers, även sådana som läggs till senare.Restricted begränsar klienten till de du väljer. |
En applikation som bara ska visa data behöver aldrig WRITE-behörighet. Om den dessutom bara ska läsa data för en viss avdelning väljer du Restricted och anger rätt säkerhetsutrymme i stället för Unrestricted.
När klienten har skapats visas den nya API-nyckeln i formatet dfk_<prefix><token>. Kopiera den direkt och spara den på en säker plats.
Om du lämnar sidan utan att kopiera nyckeln går den inte att visa igen. Då behöver du skapa en ny API-klient. Om du tappar bort nyckeln spärrar du den gamla klienten så att nyckeln inte kan missbrukas.
På klientens sida finns en länk till API-referensen, där du kan ladda ner hela specifikationen för DirSys Public API som OpenAPI-dokument i JSON- eller YAML-format.
Formatet spelar ingen roll för Claude Code – båda beskriver samma API. YAML är något mer kompakt och lättläst om du själv vill granska filen och används därför som exempel här. Spara filen på en plats där du enkelt hittar den igen, till exempel i din nedladdningsmapp.
Öppna Claude Code för Windows. Du kan antingen peka Claude Code mot en projektmapp där du vill skapa applikationen eller låta programmet arbeta i en tom mapp som du skapar för ändamålet.
Ge Claude Code tillgång till den nedladdade OpenAPI-filen (dra in filen i chatten eller ange sökvägen) och beskriv vad du vill bygga. Ett exempel:
@api.yaml
We are going to create a PHP app using DirSys public API reading
out information carriers from DirSys Security.
Var så konkret som möjligt om språk och typ av applikation (kommandoradsverktyg, webbsida eller skrivbordsapp). Om prompten är tvetydig – till exempel om du nämner två ramverk som inte hör ihop – ber Claude Code om ett förtydligande innan den börjar bygga, i stället för att gissa.
Några andra exempel att utgå från:
// Skrivbordsapp i Python
@api.yaml Build a Python desktop app with a PyQt GUI that lists
information carriers from DirSys Security and lets me store my API key.
// Kommandoradsverktyg
@api.yaml Build a Python CLI script that lists personal data processes
from DirSys Integrity, reading the API key from an environment variable.
Claude Code läser in specifikationen, skriver koden och ber om tillåtelse innan den kör kommandon som installerar paket eller startar applikationen. Testa resultatet och be om justeringar med naturligt språk – fler kolumner, ett filter eller ett annat gränssnitt – precis som i en vanlig konversation.
Resultatet av den här guiden är en skrivbordsapplikation i Python som Claude Code har byggt utifrån prompten i steg 7.
I det här fallet blev resultatet en applikation med ett grafiskt användargränssnitt i tkinter i stället för ett kommandoradsverktyg. Tkinter ingår i Python, och utöver requests krävs inga extra beroenden för gränssnittet. Huvudvyn listar informationsbärare med sortering, sidstorlek och paginering. Ett dubbelklick på en rad öppnar en detaljvy med frågor, risker och kontrollplaner som hämtas från den endpoint som innehåller detaljer för informationsbäraren.
Huvudvyn – lista med sortering, sidstorlek och paginering.
Detaljvyn – öppnas med ett dubbelklick och visar frågor, risker och kontrollplaner.
Inställningar – API-nyckel, val av miljö och knappen Test connection mot /api/public/v1/me.
Applikationen sparar API-nyckeln lokalt som en JSON-fil i %APPDATA%\DirSysICViewer\config.json, så att du slipper ange den varje gång. Den har också en inbyggd knapp för "Test connection" mot /api/public/v1/me för att verifiera nyckeln innan den sparas – samma mönster som beskrivs under Säkerhet och rekommendationer nedan.
Authorization vid varje anrop.Bra att känna till även om Claude Code sköter detta åt dig: varje anrop till DirSys API måste innehålla API-nyckeln i en Authorization-header med prefixet Bearer.
Authorization: Bearer dfk_...Ett anrop som listar informationsbärare med paginering ser ut så här:
GET https://api.dirsys.app/api/public/v1/security/information-carriers?page=0&size=25&sort=-createdAt
Authorization: Bearer dfk_...
Svaret innehåller en resultatsida med en data-array med posterna, plus page, size, totalElements och totalPages för att hantera pagineringen. Samma mönster gäller för personuppgiftsbehandlingar i DirSys Integrity.
Här är de vanligaste felen som kan uppstå när du kommer igång.
Vanligast är att Bearer -prefixet saknas framför nyckeln eller att nyckeln av misstag har kopierats med ett mellanslag eller en radbrytning. Kontrollera även att klienten inte har spärrats.
Antingen saknar klienten READ-behörighet eller så tillhör resursen ett säkerhetsutrymme (eller en controller för personuppgiftsbehandlingar) som klienten inte har åtkomst till. Det är vanligt om klienten skapades som Restricted. Gå tillbaka till klientens inställningar i Developer Portal och kontrollera Permissions och Access Restrictions.
Standardgränsen är 100 anrop/minut per klient. Ett program som pollar för ofta eller hämtar många sidor snabbt efter varandra kan nå gränsen. Be Claude Code lägga in en kort fördröjning mellan anrop eller kontakta support@dirsys.com för en högre gräns.
Se steg 1. Din roll saknar sannolikt API access (Developer portal). Det är en separat inställning som är oberoende av vilka övriga behörigheter du har i DirSys.
Guiden beskriver flödet i Developer Portal och DirSys Public API v1.0.0 så som de såg ut när guiden skrevs. Exempelapplikationen i avsnittet "Så blev applikationen" är byggd i Python (tkinter), och källkoden finns i kodarkivet dirsys-ic-viewer. Om du i stället vill koppla DirSys API till Power Apps via en anpassad connector kan du läsa den separata guiden "Från OpenAPI till Power App".