Merge branch 'feature/v1beta1' into main

Nictiz · Jun 25, 2024 · f6814a0 · f6814a0
2 parents 497967d + abe87c5
commit f6814a0
Show file tree

Hide file tree

Showing 14 changed files with 324 additions and 132 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -5,7 +5,9 @@ for an Integrated Health Information System. That is why [Nictiz](./nictiz.md),
 [Ministry of Health, Welfare and Sport](
 https://www.government.nl/ministries/ministry-of-health-welfare-and-sport){: target="_blank" } and stakeholders, has
 developed an [API strategy](https://nictiz.github.io/api-strategie-docs/){: target="_blank" } for Dutch healthcare. This
-strategy focuses on the development of APIs towards fully standardized data exchanges.
+strategy focuses on the development of APIs towards fully standardized data exchanges.  The [API Library](
+https://www.zorgapis.nl/){: target="_blank" } promotes the findability of APIs that meet the requirements at a
+particular level of standardization.
 
 ## Resources
 
@@ -15,12 +17,16 @@ strategy focuses on the development of APIs towards fully standardized data exch
 
     ---
 
+    Definition of the ZorgAPIs API.
+
     [:octicons-arrow-right-24: API reference](https://nictiz.github.io/zorgapis-openapi-specification/){: target="_blank" }
 
 -   :simple-postman:{ .lg .middle } &nbsp; **Postman Collection**
 
     ---
 
+    Fork our Postman Collection.
+
     [:octicons-arrow-right-24: Postman](https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
 
 </div>

diff --git a/docs/learn/accepting-an-invitation-to-join-an-organization.md b/docs/learn/accepting-an-invitation-to-join-an-organization.md
@@ -22,7 +22,7 @@ erDiagram
 === "Request"
 
     ```json
-    GET https://api.sandbox.zorgapis.nl/v1alpha2/users/me/invitations?filter=eq(status,"PENDING") HTTP/1.1
+    GET https://api.zorgapis.nl/v1beta1/users/me/invitations?filter=eq(status,"PENDING") HTTP/1.1
     ```
 
 === "Response"
@@ -40,14 +40,14 @@ erDiagram
     https://oas.zorgapis.nl/#tag/users.invitations/operation/listUserInvitations){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
 
 ## Accept pending invitation
 
 === "Request"
 
     ```json
-    POST https://api.sandbox.zorgapis.nl/v1alpha2/users/me/invitations/88411780-1d25-4bc3-86a5-f2f901d9a900:accept HTTP/1.1
+    POST https://api.zorgapis.nl/v1beta1/users/me/invitations/88411780-1d25-4bc3-86a5-f2f901d9a900:accept HTTP/1.1
     ```
 
 === "Response"
@@ -68,4 +68,4 @@ erDiagram
     https://oas.zorgapis.nl/#tag/users.invitations/operation/acceptUserInvitation){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
diff --git a/docs/learn/adding-an-api-specification.md b/docs/learn/adding-an-api-specification.md
@@ -20,7 +20,7 @@ erDiagram
 === "Request"
 
     ```json hl_lines="8"
-    POST https://api.sandbox.zorgapis.nl/v1alpha2/api-specifications HTTP/1.1
+    POST https://api.zorgapis.nl/v1beta1/api-specifications HTTP/1.1
     Content-Type: application/json
 
     --8<-- "learn/snippets/add-api-specification_request.json"
@@ -51,14 +51,14 @@ erDiagram
     https://oas.zorgapis.nl/#tag/api-specifications/operation/addApiSpecification){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
 
 ## Add API specification version
 
 === "Request"
 
     ```json
-    POST https://api.sandbox.zorgapis.nl/v1alpha2/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions HTTP/1.1
+    POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions HTTP/1.1
     Content-Type: application/json
 
     --8<-- "learn/snippets/add-api-specification-version_request.json"
@@ -99,14 +99,14 @@ erDiagram
     https://oas.zorgapis.nl/#tag/api-specifications.versions/operation/addApiSpecificationVersion){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
 
 ## Add declaration of conformity
 
 === "Request"
 
     ```json
-    POST https://api.sandbox.zorgapis.nl/v1alpha2/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/declarations-of-conformity HTTP/1.1
+    POST https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f/versions/15261fd0-b292-45d9-b6b1-266cc922fb50/declarations-of-conformity HTTP/1.1
     Content-Type: application/json
 
     --8<-- "learn/snippets/add-declaration-of-conformity_request.json"
@@ -130,14 +130,14 @@ erDiagram
     https://oas.zorgapis.nl/#tag/api-specifications.versions.declarations-of-conformity/operation/addApiSpecificationVersionDeclarationOfConformity){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
 
 ## Set API specification main version
 
 === "Request"
 
     ```json hl_lines="5"
-    PATCH https://api.sandbox.zorgapis.nl/v1alpha2/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f HTTP/1.1
+    PATCH https://api.zorgapis.nl/v1beta1/api-specifications/fe30bf05-de07-4556-9b17-1f82d62fe45f HTTP/1.1
     Content-Type: application/json
 
     --8<-- "learn/snippets/set-api-specification-main-version_request.json"
@@ -158,4 +158,4 @@ erDiagram
     https://oas.zorgapis.nl/#tag/api-specifications/operation/updateApiSpecification){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
diff --git a/docs/learn/adding-an-organization.md b/docs/learn/adding-an-organization.md
@@ -5,7 +5,7 @@
 === "Request"
 
     ```json
-    POST https://api.sandbox.zorgapis.nl/v1alpha2/organizations HTTP/1.1
+    POST https://api.zorgapis.nl/v1beta1/organizations HTTP/1.1
     Content-Type: application/json
 
     --8<-- "learn/snippets/add-organization_request.json"
@@ -32,4 +32,4 @@
     https://oas.zorgapis.nl/#tag/organizations/operation/addOrganization){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
diff --git a/docs/learn/authorizing-a-request.md b/docs/learn/authorizing-a-request.md
@@ -3,16 +3,16 @@
 ZorgAPIs API uses OAuth 2.0 to ensure that client requests access data securely. With OAuth 2.0, you first retrieve an
 access token for the API, then use that token to authenticate future requests.
 
-!!! note
+!!! info
 
-    When exploring our sandbox API, fork our [Postman Collection](
+    When exploring our API, fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
     and select **Get New Access Token** in the **Authorization** tab of a request. Postman will automatically populate
     the relevant parts of the request. To learn more, go to [Authenticate with OAuth 2.0 authentication in Postman](
     https://learning.postman.com/docs/sending-requests/authorization/oauth-20){: target="_blank" }.
 
-    [Register](https://auth.sandbox.zorgapis.nl/realms/zorgapis/protocol/openid-connect/registrations?response_type=code&client_id=zorgapis.docs&redirect_uri=https%3A%2F%2Fdeveloper.zorgapis.nl){ .md-button .md-button--primary }
-    [Log out](https://auth.sandbox.zorgapis.nl/realms/zorgapis/protocol/openid-connect/logout){ .md-button }
+    [Register](https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/registrations?response_type=code&client_id=zorgapis.docs&redirect_uri=https%3A%2F%2Fdeveloper.zorgapis.nl){ .md-button .md-button--primary }
+    [Log out](https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/logout){ .md-button }
 
 ## How the Authorization Code flow works
 
@@ -53,7 +53,7 @@ sequenceDiagram
 1. A user tries to access the application (the client)
 2. The application redirects to the authorization server's `auth` endpoint
     ```html
-    https://auth.sandbox.zorgapis.nl/realms/zorgapis/protocol/openid-connect/auth
+    https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/auth
         ?response_type=code
         &client_id=<client-id> <!-- (1)! -->
         &redirect_uri=<redirect-uri> <!-- (2)! -->
@@ -70,7 +70,7 @@ sequenceDiagram
 5. The authorization server issues an authorization code to the application
 6. The application requests an access token from the `token` endpoint
     ```html
-    POST https://auth.sandbox.zorgapis.nl/realms/zorgapis/protocol/openid-connect/token
+    POST https://auth.zorgapis.nl/realms/zorgapis/protocol/openid-connect/token
         ?grant_type=authorization_code
         &client_id=<client-id>
         &client_secret=<secret>

diff --git a/docs/learn/getting-api-requirements.md b/docs/learn/getting-api-requirements.md
@@ -18,7 +18,7 @@ List all must-have requirements for API specifications with the REST architectur
 === "Request"
 
     ```json
-    GET https://api.sandbox.zorgapis.nl/v1alpha2/api-requirements-versions/1.2.0/api-requirements
+    GET https://api.zorgapis.nl/v1beta1/api-requirements-versions/1.2.0/api-requirements
         ?filter=and(
             eq(requirementLevel,"MUST"), // (1)!
             any(perspectiveTypes,eq($it,"API_SPECIFICATION")), // (2)!
@@ -53,4 +53,4 @@ List all must-have requirements for API specifications with the REST architectur
     https://oas.zorgapis.nl/#tag/api-requirements-versions.api-requirements/operation/listApiRequirementsVersionApiRequirements){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
diff --git a/docs/learn/index.md b/docs/learn/index.md
@@ -1,8 +1,13 @@
 # Learn
 
-ZorgAPIs API enables the creation of applications that can interact with the API Library for Dutch Healthcare, such as
-retrieving API requirements, creating and managing organizations and API specifications, or publishing declarations of
-conformity.
+ZorgAPIs API enables the creation of applications that can interact with the [API Library for Dutch Healthcare](
+https://www.zorgapis.nl/){: target="_blank" }, such as retrieving API requirements, creating and managing organizations
+and API specifications, or publishing declarations of conformity.
+
+!!! tip
+
+    Utilize our [sandbox API](../play/index.md) to ensure your integrations are seamless and robust before publishing
+    data to the production environment.
 
 ## Getting started
 

diff --git a/docs/learn/inviting-a-user-to-an-organization.md b/docs/learn/inviting-a-user-to-an-organization.md
@@ -22,7 +22,7 @@ erDiagram
 === "Request"
 
     ```json
-    POST https://api.sandbox.zorgapis.nl/v1alpha2/organizations/4a7c2c17-6514-46f8-aa05-6a22fb18b4ad/invitations HTTP/1.1
+    POST https://api.zorgapis.nl/v1beta1/organizations/4a7c2c17-6514-46f8-aa05-6a22fb18b4ad/invitations HTTP/1.1
     Content-Type: application/json
 
     --8<-- "learn/snippets/add-invitation_request.json"
@@ -51,4 +51,4 @@ erDiagram
     https://oas.zorgapis.nl/#tag/organizations.invitations/operation/addOrganizationInvitation){: target="_blank" }
     or fork our [Postman Collection](
     https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
-    and explore our sandbox API.
+    and explore our API.
diff --git a/docs/play/index.md b/docs/play/index.md
@@ -3,6 +3,23 @@
 Explore and experiment with our sandbox API, a secure playground for developers to test functionalities, debug code, and
 innovate without disrupting live data or environments.
 
+!!! info
+
+    When exploring our sandbox API, fork our [Postman Collection](
+    https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }
+    and select **Get New Access Token** in the **Authorization** tab of a request. Postman will automatically populate
+    the relevant parts of the request. To learn more, go to [Authenticate with OAuth 2.0 authentication in Postman](
+    https://learning.postman.com/docs/sending-requests/authorization/oauth-20){: target="_blank" }.
+
+    [Register](https://auth.sandbox.zorgapis.nl/realms/zorgapis/protocol/openid-connect/registrations?response_type=code&client_id=zorgapis.docs&redirect_uri=https%3A%2F%2Fdeveloper.zorgapis.nl){ .md-button .md-button--primary }
+    [Log out](https://auth.sandbox.zorgapis.nl/realms/zorgapis/protocol/openid-connect/logout){ .md-button }
+
+!!! note
+
+    When you fork our [Postman Collection](https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" },
+    use the [environment selector](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#environment-selector-and-environment-quick-look){: target="_blank" }
+    to set **Sandbox** as the active environment.
+
 ## Resources
 
 Here you will find all the tools and assets you need to get started with the ZorgAPIs API.
@@ -11,5 +28,6 @@ Here you will find all the tools and assets you need to get started with the Zor
 
 - :simple-openapiinitiative: **[API reference](https://nictiz.github.io/zorgapis-openapi-specification/){: target="_blank" }** – Definition of the ZorgAPIs API
 - :simple-postman: **[Postman Collection](https://www.postman.com/zorgapis/workspace/zorgapis/collection/32862395-c22bf5f5-a2ec-40df-86a2-7817de5c7203){: target="_blank" }** – Fork our Postman Collection
+- :material-flask: **[Sandbox UI](https://sandbox.zorgapis.nl/){: target="_blank" }** – User interface for exploring sandbox data
 
 </div>
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -140,4 +140,5 @@ nav:
       - Accepting an invitation to join an organization: learn/accepting-an-invitation-to-join-an-organization.md
   - Play:
     - play/index.md
-  - Code: code/index.md
+  - Code: code/index.md
+  - API Library: https://www.zorgapis.nl/
diff --git a/postman/Production.postman_environment.json b/postman/Production.postman_environment.json
@@ -0,0 +1,81 @@
+{
+	"id": "38f1331d-bce7-45fe-8cb9-022055ff1d21",
+	"name": "Production",
+	"values": [
+		{
+			"key": "baseAuthUrl",
+			"value": "https://auth.zorgapis.nl",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "clientId",
+			"value": "zorgapis.postman",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "clientSecret",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "baseApiUrl",
+			"value": "https://api.zorgapis.nl",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "organizationId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "invitationId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "membershipId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "apiRequirementsVersionName",
+			"value": "1.2.0",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "apiSpecificationId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "apiSpecificationVersionId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "apiSpecificationVersionUrlId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		},
+		{
+			"key": "apiSpecificationVersionDeclarationOfConformityId",
+			"value": "",
+			"type": "default",
+			"enabled": true
+		}
+	],
+	"_postman_variable_scope": "environment",
+	"_postman_exported_at": "2024-06-25T13:29:36.044Z",
+	"_postman_exported_using": "Postman/11.2.12-240619-1520"
+}