As more and more UN/CEFACT business domains publish API standards, there is a risk of confusion and overlaps/gaps unless there is a well-managed architecture where every domain knows where they fit and all users can easily navigate the plan to find the APIs they need. This project will establish a high level “API town plan” and associated governance and publishing framework for all UN/CEFACT APIs. This project will be complete and proven successful when:
The green boxes on the right of the diagram represent a conceptual vision of the published town plan.
The town plan is a high-level artefact that is managed by a UN/CEFACT architecture function (to be created) and contains only
The detailed API specifications and dictionary semantics are managed by the relevant business domain not by the central architecture function. However the architecture function may provide a quality review of candidate specifications prior to release from “draft” to “active” status.
This project will deliver a first draft town plan and a governance framework for ongoing maintenance of the town plan as a living framework. The town plan will be maintained as a structured data set (eg a JSON file) and will be published as both structured data and a live clickable HTML page. The named resources (eg “/consignments”) on the town plan will be colour coded to indicate their status
The project will also deliver at least one documented use case that highlights the use of the town plan and associated API specifications for a long running complex trade process such as a multi-modal transport scenario for an international consignment.
The project deliverables are:
The exit criteria will be:
Membership is open to UN/CEFACT experts with broad knowledge in the area of:
In addition, Heads of Delegations may invite technical experts from their constituency to participate in the work. Experts are expected to contribute to the work based solely on their expertise and to comply with the UN/CEFACT Code of Conduct and Ethics and the policy on Intellectual Property Rights.
The geographical focus is global.
The following contributions are submitted as part of this proposal. It is understood that these contributions are only for consideration by the Project Team and that other participants may submit additional contributions in order to ensure that as much information as possible is obtained from those with expertise and a material interest in the project. It is also understood that the Project Team may choose to adopt one or more of these contributions “as is”.
List any initial contributions:
No additional secretariat resources will required.