Spring til indhold
kodefabrik
Log ind

{ api/v1 }

API for udviklere

Registrér dine applikationer og hold deres kort på kodefabrik.dk opdateret automatisk – fra CI, et deploy-script eller applikationen selv.

To slags nøgler

Brugernøgle kf_u_…

Hentes på din kontoside. Opretter applikationer og styrer alt, du ejer.

Hent en brugernøgle

App-nøgle kf_a_…

Følger med, når du opretter en applikation. Kan kun læse og opdatere netop den applikation – brug den i CI eller i applikationen.

Kom i gang

  1. 1.Opret en applikation med din brugernøgle. Svaret indeholder applikationen og dens app-nøgle – gem nøglen, den vises kun én gang.

    curl -X POST https://www.kodefabrik.dk/api/v1/apps \
      -H "Authorization: Bearer $KODEFABRIK_USER_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "name": { "da": "Vagtplan", "en": "Shift Planner" },
        "summary": { "da": "Vagtplaner til små teams", "en": "Shift plans for small teams" },
        "url": "https://vagtplan.example.dk",
        "category": "productivity",
        "visibility": "public"
      }'
  2. 2.Opdatér kortet med app-nøglen, fx ved hvert deploy. Send kun de felter, der ændres.

    curl -X PATCH https://www.kodefabrik.dk/api/v1/apps/42 \
      -H "Authorization: Bearer $KODEFABRIK_APP_KEY" \
      -H "Content-Type: application/merge-patch+json" \
      -d '{ "status": "live", "summary": { "en": "Now with exports" } }'
  3. 3.Upload logo og skærmbilleder. Send selve billedfilen som request body.

    curl -X PUT https://www.kodefabrik.dk/api/v1/apps/42/logo \
      -H "Authorization: Bearer $KODEFABRIK_APP_KEY" \
      -H "Content-Type: image/png" \
      --data-binary @logo.png
    
    curl -X POST https://www.kodefabrik.dk/api/v1/apps/42/screenshots \
      -H "Authorization: Bearer $KODEFABRIK_APP_KEY" \
      -H "Content-Type: image/png" \
      --data-binary @screenshot.png

Godt at vide

  • Applikationer er private, indtil du sætter dem til offentlige. En offentlig applikation vises i kataloget, når den er godkendt (én gang).
  • Tekster angives pr. sprog ({ "da": …, "en": … }). Mangler et sprog, vises det andet.
  • Fejl returneres som application/problem+json (RFC 9457).
  • Grænse: 60 kald i minuttet pr. nøgle, 10 uploads i minuttet.
  • Brug ETag/If-Match, hvis flere kan opdatere samme applikation.
  • Logo: kvadratisk, mindst 64×64, højst 1 MB. Skærmbilleder: mindst 480×240, højst 5 MB, op til 8.

https://www.kodefabrik.dk/api/v1

GET/meWho am I
GET/categoriesList categories
GET/appsList your apps
POST/appsCreate an app
GET/apps/{id}Get an app
PATCH/apps/{id}Update an app
DELETE/apps/{id}Delete an app
PUT/apps/{id}/logoSet the logo
DELETE/apps/{id}/logoRemove the logo
POST/apps/{id}/screenshotsAdd a screenshot
PATCH/apps/{id}/screenshots/{mediaId}Set alt text or position
DELETE/apps/{id}/screenshots/{mediaId}Remove a screenshot
GET/apps/{id}/keysList the app's keys
POST/apps/{id}/keysCreate an app key
DELETE/apps/{id}/keys/{keyId}Revoke an app key