Merge pull request #611 from maykinmedia/feature/608-admin-manual

[#608] Functioneel beheerder manual
maykinmedia · Jan 27, 2025 · 3549302 · 3549302
2 parents 83a5613 + 81c9dad
commit 3549302
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 40 deletions.
diff --git a/backend/docs/configure/index.rst b/backend/docs/configure/index.rst
diff --git a/backend/docs/configure/services.rst b/backend/docs/configure/services.rst
diff --git a/backend/docs/index.rst b/backend/docs/index.rst
@@ -13,6 +13,5 @@ Documentation
 .. toctree::
     :maxdepth: 3
 
-    configure/index
     developers/index
     manual/index
diff --git a/backend/docs/manual/1-record-manager/1.9-vernietigingsrapport-configureren.rst b/backend/docs/manual/1-record-manager/1.9-vernietigingsrapport-configureren.rst
@@ -13,7 +13,7 @@ Deze handleiding beschrijft de stappen die een **record manager** kan volgen om
 Voorwaarden
 ------------
 - De record manager moet beschikken over een actieve gebruikersaccount met de juiste toegangsrechten.
-- Externe services moeten zijn :ref:`geconfigureerd<configuration_services>`.
+- Externe services moeten zijn :ref:`geconfigureerd<manual_3-administrator_3.2-external-apis>`.
 
 Stappen
 -------

diff --git a/backend/docs/manual/3-administrator/3.2-external-apis.rst b/backend/docs/manual/3-administrator/3.2-external-apis.rst
@@ -0,0 +1,47 @@
+.. _manual_3-administrator_3.2-external-apis:
+
+==========================
+Externe API's Configureren
+==========================
+
+Deze handleiding beschrijft hoe een **functioneel beheerder** externe API-diensten kan configureren in de applicatie.
+
+Checklist
+=========
+
+1. Diensten die geconfigureerd moeten worden:
+
+   * Zaken API
+   * Catalogi API
+   * Documenten API
+   * Besluiten API
+   * Selectielijst API
+
+2. In de **API-configuratie** specificeer je welke service gebruikt moet worden voor de Selectielijst API.
+
+Diensten
+========
+
+De diensten kunnen worden geconfigureerd onder **Externe API's** > **Services** en door op **Service toevoegen** te clicken. |service_toevoegen|
+|service_config|
+
+De velden **client id** en **secret** moeten overeen komen met de waarden geconfigureerd in Open Zaak, onder **API Autorisaties** > **Applicaties**.
+|oz_applicatie_config|
+
+
+API-configuratie
+=================
+
+Onder **Externe API's** > **API-configuratie** kun je selecteren welke service gebruikt moet worden om de Selectielijst API te raadplegen.
+
+.. |service_config| image:: ../_assets/services_config.png
+    :alt: Open-Archiefbeheer admin service configuratie
+    :width: 700px
+
+.. |oz_applicatie_config| image:: ../_assets/openzaak_applicatie_auth.png
+    :alt: Open-Zaak admin applicatie configuratie
+    :width: 700px
+
+.. |service_toevoegen| image:: ../_assets/service_toevoegen.png
+    :alt: Admin service toevoegen
+    :height: 30px
diff --git a/backend/docs/manual/3-administrator/index.rst b/backend/docs/manual/3-administrator/index.rst
@@ -9,4 +9,5 @@ Administrator
    :caption: Inhoudsopgave
 
    3.1-email-templates
+   3.2-external-apis
 
diff --git a/backend/docs/manual/_assets/openzaak_applicatie_auth.png b/backend/docs/manual/_assets/openzaak_applicatie_auth.png
diff --git a/backend/docs/manual/_assets/service_toevoegen.png b/backend/docs/manual/_assets/service_toevoegen.png
diff --git a/backend/docs/manual/_assets/services_config.png b/backend/docs/manual/_assets/services_config.png
Original file line number	Diff line number	Diff line change
Expand Up		@@ -9,4 +9,5 @@ Administrator
		:caption: Inhoudsopgave

		3.1-email-templates
		3.2-external-apis