API for developers

Two kinds of keys

Getting started

1. 1.Create an application with your user key. The response contains the application and its app key – store the key, it is only shown once.

   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.Update the card with the app key, e.g. on every deploy. Send only the fields that change.

   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 a logo and screenshots. Send the image file itself as the 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

Good to know

• Applications are private until you make them public. A public application is listed once it has been approved (once).
• Texts are given per language ({ "da": …, "en": … }). If one is missing, the other is shown.
• Errors are returned as application/problem+json (RFC 9457).
• Limits: 60 requests per minute per key, 10 uploads per minute.
• Use ETag/If-Match if several parties may update the same application.
• Logo: square, at least 64×64, max 1 MB. Screenshots: at least 480×240, max 5 MB, up to 8.

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