Skip to content

Commit

Permalink
Kleinere Korrekturen in der Readme der Anträge Auslesen API.
Browse files Browse the repository at this point in the history
  • Loading branch information
ptrsauer authored and oliverharendt committed Aug 18, 2017
1 parent a28951d commit 438b39c
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,22 @@
# Anträge Auslesen API
API Definition zum Auslesen von Anträgen aus der Europace-Plattform aus Sicht eines Produktanbieters.

**Hinweis:** Es handelt sich hierbei um eine noch recht frühe Version und es werden noch Veränderungen an der API vorgenommen, die nicht abwärtskompatibel sein könnten. Dies bedeutet, dass gegen diese Version programmierte Clients später noch einmal angepasst werden müssten.

### Swagger Spezifikationen
Die API ist vollständig in Swagger definiert. Die Swagger Definitionen werden sowohl im JSON- als auch im YAML-Format zur Verfügung gestellt.

Aus diesen Dateien können mit Hilfe von [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) Clients in verschiedenen Sprachen generiert werden.

**Hinweis:** Einige wichtige Basistypen, wie zum Beispiel `Euro`, sind in der Swagger Spezifikation bisher lediglich als `number` deklariert. Hier wird die Spezifikation in Zukunft noch erweitert, um die Basistypen noch besser zu dokumentieren.

### API Documentation

- [RELEASE NOTES](RELEASE_NOTES.MD)
- [statische HTML Seite](http://htmlpreview.github.io?https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/master/Dokumentation/index.html)
- [RELEASE NOTES](https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/antraege-v1.0/RELEASE_NOTES.MD)
- [statische HTML Seite](http://htmlpreview.github.io?https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/antraege-v1.0/Dokumentation/index.html)

Zur Unterstützung für das Mapping werden folgende Dateien bereit gestellt:
- [CSV Datei](definitions.csv)
- [Excel Datei](definitions.xls)
- [CSV Datei](https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/antraege-v1.0/definitions.csv)
- [Excel Datei](https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/antraege-v1.0/definitions.xls)

Beispielantworten:
- [Ein Antrag](beispiel-antrag.json)
- [Ein Antrag](https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/antraege-v1.0/beispiel-antrag.json)

### Generierung des Clients
#### JAVA mit Retrofit
Expand All @@ -33,7 +29,7 @@ Beispielantworten:
java -jar swagger-codegen-cli-2.2.1.jar generate -i swagger.yaml -l java -c codegen-config-file.json -o europace-api-client
```

Example **codegen-config-file.json** für Version 0.1:
Example **codegen-config-file.json**:

```
{
Expand All @@ -56,9 +52,9 @@ https://tools.ietf.org/html/rfc6749#section-1.3.3
Um die Credentials zu erhalten, erfagen Sie beim Helpdesk der Plattform die Zugangsdaten zur Auslesen API, bzw. bitten Ihren Auftraggeber dies zu tun.

#### Schritte
1. Absenden eines POST Requests auf den [Login-Endpunkt](https://htmlpreview.github.io/?https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/master/Dokumentation/index.html#_oauth2) /login mit Username und Password. Der Username entspricht der PartnerId und das Password ist der API-Key. Auf dem Testsystem können diese Werte frei gewählt werden.
1. Absenden eines POST Requests auf den [Login-Endpunkt](https://htmlpreview.github.io/?https://raw.githubusercontent.com/hypoport/antraege-auslesen-api/antraege-v1.0/Dokumentation/index.html#_oauth2) /login mit Username und Password. Der Username entspricht der PartnerId und das Password ist der API-Key. Auf dem Testsystem können diese Werte frei gewählt werden. Alternativ kann ein Login auch über einen GET Aufruf mit HTTP Basic Auth auf den Login-Endpunkt erfolgen.
2. Aus der JSON-Antwort das JWToken (access_token) entnehmen
3. Bei weiteren Requests muss dieses JWToken als Authentication Header mitgeschickt werden.
3. Bei weiteren Requests muss dieses JWToken als Authorization Header mitgeschickt werden.

#### Test mit Mock-Daten
Für die Entwicklung neuer Clients können Sie mit einer Mock-Implementierung arbeiten. Diese ist unter https://baufismart.api.europace.de/mock erreichbar. So kann eine Liste von Anträgen zum Beispiel unter https://baufismart.api.europace.de/mock/antraege abgerufen werden.
Expand Down

0 comments on commit 438b39c

Please sign in to comment.