Feature/api

.gitignore

@@ -202,3 +202,6 @@ node_modules
 web/themes/custom/giv_din_stemme_theme/build/
 
 yarn-error.log
+
+# Private files
+private

CHANGELOG.md

@@ -8,6 +8,8 @@ See [keep a changelog] for information about writing changes to this log.
 
 ## [Unreleased]
 
+* [PR-48](https://github.com/itk-dev/giv-din-stemme/pull/48)
+  Add API.
 * [PR-49](https://github.com/itk-dev/giv-din-stemme/pull/49)
   Fix underlining
 * [PR-44](https://github.com/itk-dev/giv-din-stemme/pull/44)

README.md

@@ -234,3 +234,35 @@ docker compose run --rm node yarn install
 docker compose run --rm node yarn coding-standards-apply
 docker compose run --rm node yarn coding-standards-check
 ```
+
+## API
+
+Before using the api the site owner must create a user and add an API key to
+the user. Api endpoints are accessible through browser with the right user
+permissions, but private file access requires an API key.
+
+See accessible endpoints:
+
+```shell
+curl --url https://donerdinstemme.dk/jsonapi --header "api-key: <API KEY>"
+```
+
+Get recordings metadata and file relationship:
+
+```shell
+curl --url https://donerdinstemme.dk/jsonapi/gds/gds --header "api-key: <API KEY>"
+```
+
+Get file info:
+
+```shell
+curl --url https://donerdinstemme.dk/jsonapi/gds/gds/<FILE_ID>/file --header "api-key: <API KEY>"
+```
+
+### File download path
+
+Use the file info endpoint data to construct a file path i.e.
+
+```shell
+curl --url https://donerdinstemme.dk/system/files/audio/<FILE_NAME>.wav --header "api-key: <API KEY>" > myLocalFile.wav
+```

composer.json

@@ -15,6 +15,8 @@
         "drupal/core-composer-scaffold": "^11.0",
         "drupal/core-project-message": "^11.0",
         "drupal/core-recommended": "^11.0",
+        "drupal/jsonapi_extras": "^3.26@beta",
+        "drupal/key_auth": "^2.2",
         "drupal/openid_connect": "dev-3452009-drupal-11-compatibility",
         "drupal/paragraphs": "^1.18",
         "drupal/pathauto": "^1.13",