Public API delivery plan
Proposed planFor Charité / eLabFTW integration

Public API,
ready for integration.

A clear path from agreed requirements to a tested, documented OpenIRIS Public API — enabling the workflows needed for Charité’s eLabFTW integration.

Explore the delivery timeline
First, agree what success looks like. Requirements are still being gathered. The first milestone confirms the v1 scope, integration responsibilities and acceptance criteria. The dates below are proposed targets for review.

One plan. Seven delivery milestones.

Select a milestone to see the deliverables and evidence of completion.

Planned workAcceptance target

Scroll sideways to view the full November–May timeline.

Milestone and target date
Nov 2026DecJan 2027FebMarAprMay

Work windows and acceptance dates are planning targets; they do not show completed work.

Shaded interval: reduced capacity over 19 Dec–3 Jan.

What each milestone delivers

Each phase ends with a result that can be demonstrated and accepted.

01Scope and acceptance agreed2–20 Nov 2026Target 20 Nov 2026

An agreed Public API v1 scope that supports Charité’s eLabFTW integration.

What we will deliver

  • Review the existing API with Charité and the eLabFTW integration team.
  • Confirm workflows, data fields, permissions, test data and acceptance scenarios.
  • Agree who builds the connector and who accepts each milestone; prioritise the v1 backlog.
02Initial API release and onboarding23 Nov–18 Dec 2026Target 18 Dec 2026

Integrators can securely access the existing API and start testing.

What we will deliver

  • Complete API key management, separation of test and live keys, and clear onboarding instructions.
  • Validate the existing resource, booking, request, directory and charge data against deployed environments.
  • Prepare monitoring, release and rollback procedures; deliver a controlled initial release after compatibility and quality checks pass.
03Core integration workflows4–29 Jan 2027Target 29 Jan 2027

The core booking and data-linking workflows can be exercised from an external client.

What we will deliver

  • Complete the shared pricing and booking rules work, advance reservations, cancellation and required supporting data.
  • Verify the external references and updates needed to associate OpenIRIS bookings with eLabFTW records.
  • Complete agreed directory and charge data improvements, and demonstrate a first integration proof of concept.
04Agreed v1 features complete1–26 Feb 2027Target 26 Feb 2027

The agreed v1 API surface is ready for partner integration testing.

What we will deliver

  • Complete the agreed request workflows and supporting booking and request data.
  • Deliver event notifications, signed webhook delivery, retries and delivery diagnostics where required.
  • Finish any forms, attachments or bulk operations selected for v1; update the API reference and integration examples.
05Charité / eLabFTW pilot1–26 Mar 2027Target 26 Mar 2027

The API supports the agreed integration scenarios in a representative eLabFTW environment.

What we will deliver

  • Run the agreed end-to-end scenarios jointly with the integration owner.
  • Test permissions, data mapping, updates, duplicate submissions, event handling and error recovery as applicable.
  • Resolve integration defects; agree the final acceptance test pack and freeze the release scope.
06Acceptance and release readiness29 Mar–23 Apr 2027Target 23 Apr 2027

A tested release candidate is ready for production acceptance.

What we will deliver

  • Run Charité user acceptance testing and resolve release-blocking defects.
  • Complete checks for data consistency, permissions, provider isolation, real database queries and representative performance.
  • Rehearse release and rollback; finish documentation, monitoring, support arrangements and operational handover.
07Production delivery and handover26 Apr–7 May 2027Target 7 May 2027

The agreed Public API v1 is released, documented and handed over.

What we will deliver

  • Promote the accepted release and confirm the priority workflows in production.
  • Provide final API documentation, integration examples, key-management instructions and support contacts.
  • Complete handover and acceptance; use the remaining delivery window for launch fixes and record follow-up work.

How we keep delivery on track

Quality from the first release

QA runs throughout delivery. Every increment includes functional checks, permissions and data consistency tests, with April focused on acceptance and fixes.

Regular, visible progress

Fortnightly demonstrations and monthly milestone reviews make progress tangible. New requirements are prioritised against the agreed scope and delivery window.

Joint integration testing

The integration team provides the eLabFTW environment and agreed connector work. We validate real workflows together before the final production handover.

Three decisions to settle in November.

A focused starting agreement gives the project a clear finish.

  1. The workflows required for v1

    Confirm the data and operations eLabFTW needs. Select any additional forms, attachments, notifications or bulk operations that belong in the initial delivery.

  2. Ownership of the connector and test environment

    Agree who builds each side of the integration, supplies sample data, and makes the eLabFTW environment available for the January proof of concept and March pilot.

  3. The people and evidence for acceptance

    Nominate the requirements and acceptance contacts, and agree the scenarios that demonstrate each milestone is complete.