Skip to content

Commit 4ea5cda

Browse files
authored
Update README.md
Improve formatting + Fix broken link
1 parent 8ddfdfe commit 4ea5cda

File tree

1 file changed

+14
-36
lines changed

1 file changed

+14
-36
lines changed

README.md

Lines changed: 14 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -8,37 +8,24 @@
88

99
# bzst-dip-java-client
1010

11-
Client for using
12-
the [Mass data transmission DIP (mass data
13-
interface)](https://www.bzst.de/EN/Businesses/CESOP/electronic_data_transmission/electronic_data_transmission_node.html#js-toc-entry1).
11+
Client for using the [Mass data transmission DIP (mass data interface)](https://www.bzst.de/EN/Businesses/CESOP/electronic_data_transmission/electronic_data_transmission_node.html#js-toc-entry1).
1412

15-
The BZSt (Bundeszentralamt für Steuern / Federal Central Tax Office) provides the Digital Inbox (DIP) as a service
16-
for payment service providers to transmit financial data.
13+
The BZSt (Bundeszentralamt für Steuern / Federal Central Tax Office) provides the Digital Inbox (DIP) as a service for payment service providers to transmit financial data.
1714

18-
Clients need to register / login
19-
at [BZSt online.portal](https://www.bzst.de/DE/Service/Portalinformation/Massendaten/DIP/dip.html?nn=68828)
20-
through [Elster](https://www.elster.de/elsterweb/start), [BundID](https://id.bund.de/de)
21-
or [BZSt Online-Portal (BOP)](https://www.elster.de/bportal/start).
15+
Clients need to register / login at [BZSt online.portal](https://www.bzst.de/DE/Service/Portalinformation/Massendaten/DIP/dip.html?nn=68828) through [Elster](https://www.elster.de/elsterweb/start), [BundID](https://id.bund.de/de) or [BZSt Online-Portal (BOP)](https://www.elster.de/bportal/start).
2216

23-
See
24-
the [BZSt Information](https://www.bzst.de/EN/Service/Portalinformation/Login/login_node.html)
25-
for more information.
17+
See the [BZSt Information](https://www.bzst.de/EN/Service/Portalinformation/Login/login_node.html) for more information.
2618

27-
*Warning*: **BZSt Online-Portal** (deprecated) is different from **BZSt online.portal**.
19+
> [!NOTE]
20+
> **BZSt Online-Portal** (deprecated) is different from **BZSt online.portal**.
2821
2922
## Rationale
3023

3124
We created this client to make it as easy as possible for the developer to use the BZSt DIP.
32-
Through usage of the builder pattern (see [Configuration](#configuration) below), DTOs
33-
and a typesafe data model we ensure high usability and readability.
25+
Through usage of the builder pattern (see [Configuration](#configuration) below), DTOs and a typesafe data model we ensure high usability and readability.
3426

35-
The BZSt
36-
provides [XSD](https://www.bzst.de/SharedDocs/Downloads/DE/Digitale_Plattformbetreiber/amtlicher_datensatz_entwurf) that
37-
define the expected XML structure and
38-
make it possible to generate java
39-
classes ([BZSt Docs](https://www.bzst.de/DE/Unternehmen/Intern_Informationsaustausch/DAC7/Handbuecher/handbuecher.html?nn=127558#js-toc-entry2)).
40-
Our library validates each
41-
request through these XSD find errors before they are sent to the DIP.
27+
The BZSt provides [XSD](https://www.bzst.de/SharedDocs/Downloads/DE/Digitale_Plattformbetreiber/amtlicher_datensatz_entwurf) that define the expected XML structure and make it possible to generate java classes ([BZSt Docs](https://www.bzst.de/DE/Unternehmen/Intern_Informationsaustausch/DAC7/Handbuecher/handbuecher.html?nn=127558#js-toc-entry2)).
28+
Our library validates each request through these XSD find errors before they are sent to the DIP.
4229

4330
## Installation
4431
[Installation guide for the latest release](https://github.com/xdev-software/bzst-dip-java-client/releases/latest#Installation)
@@ -51,9 +38,7 @@ See the [examples in the demo package](./bzst-dip-java-client-demo/src/main/java
5138

5239
For authentification at the BZST you have to create a public- and private-key.
5340

54-
First you have to create a **PEM** file as described on
55-
the [BZST Website](https://www.bzst.de/SharedDocs/Downloads/DE/EOP_BOP/khb_dip.pdf?__blob=publicationFile&v=9) (see
56-
1.7).
41+
First you have to create a **PEM** file as described on the [BZST Website](https://www.bzst.de/DE/Service/Portalinformation/Massendaten/DIP/dip_node.html) (see 1.7).
5742

5843
OpenSSL can be downloaded from their [website](https://www.openssl.org/).
5944

@@ -67,15 +52,13 @@ Next you have to convert that file to a **PKCS12** file.
6752
openssl pkcs12 -export -in cert.pem -inkey key.pem -out certificate.p12 -name "certificate"
6853
```
6954

70-
The [keytool](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html) is contained in your JDK
71-
installation.
55+
The [keytool](https://docs.oracle.com/javase/8/docs/technotes/tools/unix/keytool.html) is contained in your JDK installation.
7256

7357
```
7458
keytool -importkeystore -srckeystore certificate.p12 -srcstoretype pkcs12 -destkeystore cert.jks
7559
```
7660

77-
The password you insert here, along with the file itself must be set in the client configuration. See example
78-
at [app.properties](./bzst-dip-java-client-demo/src/main/resources/app.properties):
61+
The password you insert here, along with the file itself must be set in the client configuration. See example at [app.properties](./bzst-dip-java-client-demo/src/main/resources/app.properties):
7962

8063
```
8164
certificate.keystore.password=SECRET_PASSWORD
@@ -101,11 +84,7 @@ client.id=abcd1234-ab12-ab12-ab12-abcdef123456
10184

10285
### Configuration
10386

104-
The client can be configured through a properties file (
105-
see [app.properties](./bzst-dip-java-client-demo/src/main/resources/app.properties)
106-
and [ApplicationWithConfigurationFromProperties.java](./bzst-dip-java-client-demo/src/main/java/software/xdev/ApplicationWithConfigurationFromProperties.java))
107-
or by creating a configuration object (
108-
see [Application.java](./bzst-dip-java-client-demo/src/main/java/software/xdev/Application.java)).
87+
The client can be configured through a properties file (see [app.properties](./bzst-dip-java-client-demo/src/main/resources/app.properties) and [ApplicationWithConfigurationFromProperties.java](./bzst-dip-java-client-demo/src/main/java/software/xdev/ApplicationWithConfigurationFromProperties.java)) or by creating a configuration object (see [Application.java](./bzst-dip-java-client-demo/src/main/java/software/xdev/Application.java)).
10988

11089
```java
11190
public static BzstDipConfiguration createConfiguration()
@@ -130,8 +109,7 @@ public static BzstDipConfiguration createConfiguration()
130109

131110
## Support
132111

133-
If you need support as soon as possible, and you can't wait for any pull request, feel free to
134-
use [our support](https://xdev.software/en/services/support).
112+
If you need support as soon as possible, and you can't wait for any pull request, feel free to use [our support](https://xdev.software/en/services/support).
135113

136114
## Contributing
137115
See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.

0 commit comments

Comments
 (0)