Integration Process
Every YAPU API integration follows a structured three-phase delivery process. This page explains each phase, who is responsible for what, and what to expect at each step.
Process overview
Specification → Development → Testing → System ready
(1–3 weeks) (2–8 weeks) (1–2 weeks)
Timelines are approximate. Development duration depends on YAPU's internal software prioritization and the speed at which your team completes development.
Phase 1 — Specification
Duration: 1–3 weeks after contract signature
The specification phase establishes a shared technical understanding before any development begins. Both parties must agree on the integration design before moving forward.
Steps
| Step | Led by | Description |
|---|---|---|
| 1. Requirements call | Both | A mutual call to identify your REST API requirements and integration goals |
| 2. Use case creation | YAPU | YAPU creates the API use case and data / user flow diagram |
| 3. Use case agreement | Both | Both parties review and agree on the use case and flow |
| 4. Data specification | YAPU-guided | YAPU guides the client through specifying the exact data to be transferred |
| 5. Technical documentation | YAPU | YAPU creates the full technical API documentation |
| 6. Documentation agreement | Both | Both parties review and approve the technical documentation |
Outputs
- Agreed use case and flow diagram
- Finalized technical API documentation
- Confirmed data fields and formats for both directions
Prepare your integration team for the requirements call. The more clearly you can describe your operational workflow and what your system needs to do, the faster the specification phase moves.
Phase 2 — Development
Duration: 2–8 weeks after specification is complete
Both YAPU and the client develop their respective sides of the integration in parallel, working from the agreed technical documentation.
YAPU development
YAPU's engineering team implements the API endpoints and integration logic on the YAPU platform side.
Client development
Your development team implements the integration on your system's side — making requests to YAPU's API and handling responses according to the agreed specification.
Alignment
If questions or discrepancies arise during development, alignment calls are held between YAPU and the client team to resolve them before testing.
:::warning Development timeline note The 2–8 week range reflects variability in YAPU's internal software prioritization queue and client-side development speed. Your YAPU contact will keep you informed of YAPU's development schedule. :::
Phase 3 — Testing
Duration: 1–2 weeks after both sides have finalized development
Testing confirms that the integration works end-to-end before going live in production.
Testing steps
| Step | Environment | Description |
|---|---|---|
| 1. Internal testing | Each party's own system | Each side tests their own implementation independently |
| 2. Mutual integration testing | Staging | Both parties test the full integration together in the staging environment |
| 3. Production deployment | Production | Both sides deploy their integration to production |
| 4. Mutual integration testing | Production | Both parties test the full integration in production to confirm go-live readiness |
Once production testing is confirmed by both parties, the system is ready to use.
Responsibilities summary
| Responsibility | YAPU | Client |
|---|---|---|
| Create use case and flow diagram | ✓ | |
| Guide data specification | ✓ | |
| Create technical API documentation | ✓ | |
| Develop YAPU-side API | ✓ | |
| Develop client-side integration | ✓ | |
| Internal testing of own development | ✓ | ✓ |
| Mutual staging integration testing | ✓ | ✓ |
| Deploy to production | ✓ | ✓ |
| Mutual production integration testing | ✓ | ✓ |
Total timeline estimate
| Phase | Estimated duration |
|---|---|
| Specification | 1–3 weeks |
| Development | 2–8 weeks |
| Testing | 1–2 weeks |
| Total | 4–13 weeks |
After go-live
Once the system is in production and both parties have confirmed the integration is working correctly, a stabilization period begins. During this period, your YAPU contact remains available to support any issues that arise from live usage.
See Testing & Go-Live for details on the testing process and go-live checklist.