Skip to content

Commit 1bbea33

Browse files
johannesbattjesCopilotGrabauskas
authored
Explanation of Postman tests added (#84)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Giedrius Grabauskas <43740166+Grabauskas@users.noreply.github.com>
1 parent 1cc64c8 commit 1bbea33

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

getting-started/docker-compose/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
- [Step 5.3: Request an Access Token](#step-53-request-an-access-token)
1717
- [For Windows (PowerShell)](#for-windows-powershell)
1818
- [For Linux, macOS, or WSL (cURL)](#for-linux-macos-or-wsl-curl)
19+
- [Step 5.4: Creating a Sample Case Using Postman](#step-54-creating-a-sample-case-using-postman)
1920
- [6. Stopping the Services](#6-stopping-the-services)
2021
- [Service Endpoints and Tools](#service-endpoints-and-tools)
2122
- [ZGW API Services](#zgw-api-services)
@@ -243,6 +244,33 @@ You will receive a JSON response containing the `access_token`. You can now use
243244
>
244245
> You will need to request a new token for this change to take effect.
245246

247+
#### Step 5.4: Creating a Sample Case Using Postman
248+
249+
You can quickly test the Zaken API by creating a sample case ("zaak") using Postman and the provided [ZGW-APIs-postman-tests](https://github.com/OneGround/ZGW-APIs-postman-tests) project.
250+
251+
**Steps:**
252+
253+
1. **Import the Create Case project**
254+
255+
- Open Postman.
256+
- Import the Create Case collection and environment files from the [ZGW-APIs-postman-tests](https://github.com/OneGround/ZGW-APIs-postman-tests) repository.
257+
258+
2. **Obtain an Access Token**
259+
260+
- Follow the instructions in the "Configure API Authentication" section above to get a valid access token.
261+
- Paste the token into the `jwt_token` variable in your Postman Create Case Environment.
262+
263+
3. **Set Up Other Environment Variables**
264+
265+
- Update the variables for your local setup if they deviate from standard set up, such as `zrc_url`.
266+
267+
4. **Create a Sample Case**
268+
269+
- In the imported collection `ZGW Create Case`, find the folder named `Casetype`. Click 'run' and 'Run ZGW Create Case'. The catalog will be created, a case and other types will be added.
270+
- Find the folder named `Case`. Click 'run' and 'Run ZGW Create Case'. The case with related entities (status, result, document) will be added. If you need more cases run it multiple times.
271+
272+
> For more details and advanced scenarios, see the documentation in the Postman collection.
273+
246274
### 6. Stopping the Services
247275

248276
To stop all running Docker containers, run the following command from the `docker-compose` directory:

0 commit comments

Comments
 (0)