Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.67 KB

Interface_Doc.md

File metadata and controls

45 lines (29 loc) · 1.67 KB

Interface Documentation

This document provides information on the interfaces. It more or less links you to the relevant sections in other documentations.

Overview of Data Exchange Interfaces

The arc42 documentation provides an overview based on the following chapters:

  • Building Block View shows which kind of interfaces are present
  • Runtime View shows how data with participants is exchanged (implementation of standardization candidate)

Swagger documentation

Please refer to the open API specification provided in docs/api/openAPI.yaml.

To have a running swagger ui, feel free to check out the INT environment.

http://puris-customer.int.demo.catena-x.net/swagger-ui/index.html

To have a running and executable swagger ui, feel free to also deploy the backend application according to the Install.md in the backend and use the following path. To authorize requests copy the value of key CUSTOMER_BACKEND_API_KEY in local/.env.

http://localhost:8081/catena/swagger-ui/index.html

Note: The port and the path depend on the configuration of the spring backend (port and context path).

Postman

There is a postman collection containing information on how to provide master data and some basic data to test the application.

NOTICE

This work is licensed under the Apache-2.0.