The built-in IDpack API Client is designed to test API calls, verify functionality, and review payload formats to assist with system integration. This feature, accessible from the Dashboard → API → Open API Client tab, is included in the IDC Professional and IDC Enterprise plans. By providing a hands-on environment for debugging and payload testing, the API Client ensures a smoother integration of IDC into your system, saving time and effort during development.
Test and Retrieve with the API Client
- Retrieve a data structure (JSON or XML) from a Project Record, with options to include a Base64-encoded Photo ID and/or Badge Preview.
- Retrieve a data structure (JSON or XML) containing all Records from a Project (without Photo ID or Badge Preview).
- Retrieve a Base64-encoded Photo ID in WebP, PNG, or JPEG format at resolutions of 240×300 pixels (portrait) or 300×300 pixels (square).
- Retrieve a Base64-encoded Badge Preview in WebP, PNG, JPEG, or PDF format at resolutions of 1013×639 pixels (landscape) or 639×1013 pixels (portrait).
- Insert data into a Project using POST, including adding a Base64-encoded Photo ID and setting the status to ACTIVE, TRASH, or CHECK_IN.
- Update a Project Record using PUT, including modifying data structures, adding a Base64-encoded Photo ID, and updating the status to ACTIVE, TRASH, DELETE, or CHECK_IN.
You can further test your API connection and payloads using popular desktop applications such as: