Application Programming Interface Technical Specification (API TechSpec)
other Linktoparent
Project Details
| Page properties | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Project Purpose
| Text Area | ||||
|---|---|---|---|---|
| ||||
Multiple groups within UN/CEFACT wish to develop standard Application Programming Interfaces (APIs) as part of the set of technical deliverables from their project. The RDM2API project demonstrated that it is possible to go from the semantics of UN/CEFACT towards APIs. This project aims to develop a technical specification in order to move from Reference Data Model (RDM) based deliverables to a standardized API which retains the richness of information available in RDMs. |
Project Scope
| Text Area | ||||
|---|---|---|---|---|
| ||||
Develop a technical specification which will standardize API production for UN/CEFACT RDM-based deliverables. |
Project Deliverables
| Text Area | ||||
|---|---|---|---|---|
| ||||
The project deliverables is:
• Deliverable 1: Application Programming Interface Technical Speciation )API-TechSpec)
|
Exit Criteria
| Text Area | ||||
|---|---|---|---|---|
| ||||
The exit criteria will be:
• API Tech Spec ready for publication and Public Review disposition log demonstrating that all Public Review comments have been addressed. |
Project Team Membership and Required Functional Expertise
| Text Area | ||||
|---|---|---|---|---|
| ||||
Membership is open to UN/CEFACT experts with broad knowledge in the area of: broad knowledge of UN/CEFACT e-business standards and/or API technical knowledge. 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. |
Geographical Focus
| Text Area | ||||
|---|---|---|---|---|
| ||||
The geographical focus of the project is global. |
Initial Contributions
| Text Area | ||||
|---|---|---|---|---|
| ||||
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:
• RDM2API project “JSON -LD Vocabulary Publishing” guideline
• RDM2API project “API 3.0 NDR and interface conformance rules” guideline
|
Resource Requirements
| Text Area | ||||
|---|---|---|---|---|
| ||||
Participants in the project shall provide resources for their own participation. The existence and functioning of the project shall not require any additional resources from the UNECE secretariat. |
Project Proposal Files
| Attachments |
|---|