Skip to main content

Getting Started

This guide walks you through the first steps of a YAPU API integration — from understanding the prerequisites to knowing what the onboarding process looks like.

Prerequisites​

Before beginning a YAPU API integration, make sure the following are in place:

RequirementDescription
Signed contractA YAPU API integration requires an active contract. The delivery process begins after signature.
Assigned YAPU contactYou will work with a YAPU Customer Success or Digitalization team representative throughout the process.
Technical team availableYour organization needs a development team capable of implementing a REST API connection over HTTPS.
JSON capabilityAll YAPU API requests and responses use JSON. Your systems must be able to send and parse JSON.
HTTPS supportAll communication with YAPU APIs must happen over HTTPS. HTTP is not supported.
Dynamic IP supportYAPU operates with dynamic IP communication. Static IP communication is not supported.

Onboarding overview​

A YAPU API integration follows three structured phases. Your YAPU contact guides you through each one.

Phase 1 — Specification (1–3 weeks)​

During specification, YAPU and your team align on the integration requirements:

  1. A mutual call is held to identify your REST API requirements.
  2. YAPU creates an API use case and data / user flow diagram.
  3. Both parties review and agree on the use case and flow.
  4. YAPU guides your team through specifying the required data to be transferred.
  5. YAPU creates the technical API documentation.
  6. Both parties agree on the final technical documentation before development begins.

Phase 2 — Development (2–8 weeks)​

Both YAPU and your team develop their respective sides of the integration in parallel. Alignment calls are held if clarification is needed. Timeline depends on YAPU's internal software prioritization and how quickly your team completes development.

Phase 3 — Testing (1–2 weeks)​

Testing runs in two stages:

  1. Each party tests their own implementation individually.
  2. Mutual integration testing is conducted in the staging environment.
  3. Both sides deploy to production.
  4. Mutual integration testing is conducted in the production environment.

Once production testing is complete, the system is ready to use.

What to expect​

  • Timeline: A typical integration takes between 4 and 13 weeks from contract signature, depending on complexity, prioritization, and client development speed.
  • Support: Your YAPU contact is available throughout all phases to answer questions and unblock issues.
  • Documentation: YAPU provides technical API documentation as part of the specification phase. This portal serves as a supplementary reference.

Next steps​

Once your contract is in place and your YAPU contact has been assigned, your first step is the specification call. In the meantime, explore the following sections to prepare your team:

tip

Use the API Bundles overview and Integration Process pages to prepare questions for your specification call with YAPU.