|
|
|
# Capitol API
|
|
|
|
This repository contains Java classes and documentation concerning to the API to and from the business partners of Capitol Inc.
|
|
|
|
|
|
|
|
## For Externals
|
|
|
|
If you are a business partner of Capitol Inc., you may want to check out [how to use our API](api-usage).
|
|
|
|
|
|
|
|
## For Internals
|
|
|
|
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).
|
|
|
|
Documentation that is not belonging to a specific class or is on a higher level of abstraction can be found in this wiki. There is a [page list](pages) that lists up all documents.
|
|
|
|
|
|
|
|
## Data formats
|
|
|
|
### Data formats
|
|
|
|
All our external APIs use JSON.
|
|
|
|
We prefer JSON when using the API of business partners as well.
|
|
|
|
|
|
|
|
## Technologies
|
|
|
|
### Technologies
|
|
|
|
All our external APIs are provided via REST endpoints.
|
|
|
|
We prefer REST endpoints when using the API of business partners as well.
|
|
|
|
|
|
|
|
## Data Workflow
|
|
|
|
### Data Workflow
|
|
|
|
The data workflow from and to business partners is documented in the [data workflow page](data-workflow). |
|
|
|
|
