|
|
|
# Capitol API
|
|
|
|
This repository contains Java classes and documentation concerning to the API to and from the business partners of Capitol Inc.
|
|
|
|
All Java classes should be well documented via JavaDoc.
|
|
|
|
Documentation that is not belonging to a specific class or is on a higher level of abstraction can be found in our [wiki](../../wikis/home).
|
|
|
|
|
|
|
|
## Data formats
|
|
|
|
All our external APIs use JSON.
|
|
|
|
We prefer JSON when using the API of business partners as well.
|
|
|
|
|
|
|
|
## Technologies
|
|
|
|
All our external APIs are provided via REST endpoints.
|
|
|
|
We prefer REST endpoints when using the API of business partners as well.
|
|
|
|
|
|
|
|
## Quickstart
|
|
|
|
### BVIS data flow
|
|
|
|
* [in] [add contract](../../wikis/bvis/data-flow/add-contract.md) [todo:add link to java class]
|
|
|
|
|
