Before a partner can leverage VONQ's Hiring API (HAPI) in a live environment, a formal acceptance test is required to ensure a smooth and successful integration. This comprehensive testing and validation process is managed internally by VONQ's Partnerships, Product & Engineering, and Operations teams. Partners are not permitted to go live until they receive official approval from all involved teams at VONQ.
This guide outlines the critical steps in the HAPI testing process, from the initial sandbox environment to production deployment and post-live support
The Three Pillars of Testing
The validation process is structured around three core stages, each designed to ensure data integrity, feature completeness, and a seamless user experience.
-
Sandbox Testing: This initial phase focuses on order completeness and data validation in a controlled environment. It is primarily supported by the Operations and Partnerships teams.
-
API Product Demo: During this stage, the partner presents their integration to VONQ. The focus is on validating the user experience, feature implementation, and the positioning of the API within the partner's platform7. This is supported by the Partnerships and Product teams.
-
Production Testing: The final phase involves end-to-end testing with live data. It covers everything from account setup to order completeness and data validation, ensuring the integration is ready for real customers. Support is provided by the Operations and Partnerships teams.
Stage 1: Sandbox Environment Testing
Testing in the sandbox is the foundational step where core functionalities are validated. This process is broken down into specific tests depending on the features being implemented.
Job Marketing Sandbox Testing
This test ensures that campaign orders are correctly transmitted and processed.
-
Process: The partner provides specific campaign IDs for validation. The VONQ Operations team then validates these campaigns.
-
Validation Points: Checks are performed to confirm that sandbox orders are received successfully and that the data within the order, such as the company logo and job description, is correct and functional.
-
Duration: This process typically takes two days to complete.
-
Next Step: Upon successful completion, the next step is the Product Demo.
Job Post Sandbox Testing
This test focuses on integrations that post jobs directly to job boards via contracts.
-
Process: The partner grants VONQ access to their sandbox environment and provides campaign IDs for validation. The VONQ Product Team then validates these specific campaigns.
-
Validation Points: This is a more detailed validation that checks if:
-
Contracts are correctly created for every type of job board.
-
Posting requirements forms are rendered, validated, and loaded correctly.
-
Forms react properly to display rules.
-
Sandbox orders are successfully delivered to the job posting queue.
-
Order and vacancy information is complete.
-
A user can connect multiple contracts for the same job board.
-
-
Duration: This validation requires three days.
-
Next Step: The next phase is the Product Demo.
Wallet Sandbox Testing
For partners using the wallet feature, this test validates billing and transaction functionalities.
-
Process: The partner supplies a campaign ID, customer ID, and wallet ID. The VONQ Product team then confirms the wallet balance and supports the test.
-
Validation Points: The test ensures wallet data is complete, invoices are generated correctly, and amounts deducted match order prices. It also verifies that the sandbox wallet is correctly associated with the campaign, the balance updates when an order is placed, and the balance is reinstated if an order is rejected.
-
Duration: This test takes two days.
-
Next Step: The process moves forward to the Product Demo.
Stage 2: The API Product Demo
After successful sandbox testing, the partner conducts a product demo for VONQ's Partnerships and Product teams. This demo is a critical checkpoint to validate the real-world application of the API integration.
-
Purpose: The demo is used to assess which features of the HAPI have been implemented and to confirm they are working correctly34. It also evaluates the overall positioning of the API within the Applicant Tracking System (ATS) and the user workflow for accessing it. Partners are asked to fill out and share a feature and implementation checklist with their VONQ account manager.
-
Duration: The product demo is completed in one day.
-
Next Step: Following a successful demo, VONQ delivers the production API key to the partner.
Stage 3: Production Environment Testing
With the production key, the final testing phase begins. This stage ensures that the integration works flawlessly in a live setting and typically takes about one week to complete.
Job Marketing Production Testing
This is a three-phase process:
-
Phase 1: The Partnership team validates the account and billing details.
-
Phase 2: The partner sends three test orders on the production environment, which the Operations team validates and then rejects. (This rejection step is not applicable for HAPI Job Post).
-
Phase 3: The partner sends three live jobs from actual customers, which Operations will advertise for free on LinkedIn to confirm the end-to-end process.
Validation during this test confirms that account details are correct, order data is complete, job descriptions are designed properly, and orders are published correctly with proper UTM tracking. For wallet integrations, it also confirms wallet data is complete and that invoices and deductions are processed correctly. Once complete, the partner is approved to go live.
Job Post Production Testing
This test ensures that job postings function correctly in the live environment.
-
Process: The partner provides campaign IDs, which the VONQ Product team validates.
-
Validation Points: The test confirms that production orders are received with correct data, status updates function as expected, errors are displayed properly, and jobs can be successfully posted and taken offline. It also validates contract credentials and lazy-loaded options.
-
Duration: This process takes one day.
-
Next Step: Upon completion, the next step is the Product Demo.
Life After Go-Live
Post-Live Campaign Feedback
For the first four weeks after going live, VONQ conducts additional manual checks on all incoming orders to ensure they contain the correct information. Any orders that do not meet the requirements will be rejected, and the partner will be notified to make changes. After this initial period, orders are expected to meet all requirements and will be processed automatically without manual checks.
Introducing New Features
If a partner wishes to introduce new API features after the initial go-live, these features must first be properly tested in the sandbox environment. Partners must notify VONQ before moving new features into production, preferably ahead of time so VONQ can allocate the necessary resources for support. VONQ can support a gradual rollout, starting with a select number of customers before scaling up.
This article can be viewed as a presentation here