Merge branch 'AndreasFischer1985:main' into main

README.md

@@ -1,15 +1,15 @@
 # Arbeitsagentur Berufenet API 
 Die Bundesagentur für Arbeit verfügt mit BERUFENET über das umfangreichste Lexikon der Berufe in Deutschland.
 
-Aktuell listet BERUFENET 3569 Berufe, davon 830 Ausbildungsberufe, 725 Studiengänge, 748 Weiterbildungsberufe - die zu 94% konkreten Tätigkeiten zugeordnet sind - und 1266 sonstige Tätigkeiten (von Helfertätigkeiten bis zu Hochschulberufen). Insg. werden 2730 Tätigkeiten unterschieden. Neben den gelisteten Berufen ist auch ein Zugriff auf nicht-gelistete Berufe möglich (z.B. ID 1674) jedoch nicht Gegenstand der vorliegenden Dokumentation.
+BERUFENET listet etwa 3569 Berufe, davon 830 Ausbildungsberufe, 725 Studiengänge, 748 Weiterbildungsberufe - die zu 94% konkreten Tätigkeiten zugeordnet sind - und 1266 sonstige Tätigkeiten (von Helfertätigkeiten bis zu Hochschulberufen). Insg. werden 2730 Tätigkeiten unterschieden. Neben den gelisteten Berufen ist auch ein Zugriff auf nicht-gelistete Berufe möglich (z.B. ID 1674) jedoch nicht Gegenstand der vorliegenden Dokumentation.
 
 
 ## Authentifizierung
-Die Authentifizierung funktioniert über die client-id von Berufenet, die einem GET-request an https://web.arbeitsagentur.de/berufenet/ergebnisseite/berufe-a-z entnommen werden kann:
+Die Authentifizierung funktioniert über die *clientId* von Berufenet, die einem GET-request an https://web.arbeitsagentur.de/berufenet/ergebnisseite/berufe-a-z entnommen werden kann:
 
-**Client-ID:** d672172b-f3ef-4746-b659-227c39d95acf
+**clientId**: infosysbub-berufenet
 
-Die Client-ID muss bei allen GET-requests als Header-Feld 'X-API-Key' übergeben werden.
+Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.
 
 
 
@@ -77,13 +77,13 @@ Die Informationen umfassen:
 - Steckbrief
 - Aufstiegsweiterbildungen
 - Anpassungsweiterbildungen
-- Fachrichtunge
+- Fachrichtungen
 - Meta-Fachrichtung
 - Tätigkeitsfelder
 - Einsatzmöglichkeiten
 - Metaeinheit
 
-Zu Ausbildungsberufen, Weiterbildungsberufen und Studiengängen werden darüber hinaus idR. Informationen zu einer zugeordneten Tätigkeit ausgewiesen (mit separater Berufe-ID).
+Zu Ausbildungsberufen, Weiterbildungsberufen und Studiengängen werden darüber hinaus idR. Informationen zu einer zugeordneten Tätigkeit ausgewiesen (mit separater Berufs-ID).
 
 ### Beispiel:
 

api_example.R

@@ -14,10 +14,10 @@ xApiKey=substr(xApiKey,12,nchar(xApiKey)-1)
 # BERUFENET-Berufsliste:
 #-----------------------
 url="https://rest.arbeitsagentur.de/infosysbub/bnet/pc/v1/berufe?suchwoerter=*"
-x=rawToChar(httr::content(httr::GET(url, httr::add_headers("X-API-Key"="d672172b-f3ef-4746-b659-227c39d95acf"))))
+x=rawToChar(httr::content(httr::GET(url, httr::add_headers("X-API-Key"=xApiKey))))
 pages=jsonlite::fromJSON(x)$page$totalPages
 x=lapply(0:(pages-1),function(x) rawToChar(httr::content(httr::GET(paste0(url,"&page=",x), 
-	httr::add_headers("X-API-Key"="d672172b-f3ef-4746-b659-227c39d95acf")))))
+	httr::add_headers("X-API-Key"=xApiKey)))))
 
 y=data.frame(
 unlist(lapply(x,function(x)jsonlite::fromJSON(x)$'_embedded'$berufSucheList[,1])),
@@ -28,6 +28,6 @@ write.csv2(y,"berufe.csv")
 # BERUFENET-Berufsinformationen:
 #-------------------------------
 url="https://rest.arbeitsagentur.de/infosysbub/bnet/pc/v1/berufe/129987"
-x=httr::content(httr::GET(url, httr::add_headers("X-API-Key"="d672172b-f3ef-4746-b659-227c39d95acf")))
+x=httr::content(httr::GET(url, httr::add_headers("X-API-Key"=xApiKey)))
 writeLines(jsonlite::toJSON(x), "berufenet-infos_bsp1.json", useBytes=T)
 

openapi.yaml

@@ -3,11 +3,12 @@ info:
   title: "Arbeitsagentur Berufenet API"
   description: |
    Die Bundesagentur für Arbeit verfügt mit BERUFENET über das umfangreichste Lexikon der Berufe in Deutschland.
-   
-   **Client-ID:** d672172b-f3ef-4746-b659-227c39d95acf
-   
-   Die Client-ID muss bei allen GET-requests als Header-Feld 'X-API-Key' übergeben werden.
-  version: "1.0.0"
+   Die Authentifizierung funktioniert über die *clientId* von Berufenet, die einem GET-request an https://web.arbeitsagentur.de/berufenet/ergebnisseite/berufe-a-z entnommen werden kann:
+
+   *clientId*: infosysbub-berufenet
+
+   Bei folgenden GET-requests ist die clientId als Header-Parameter 'X-API-Key' zu übergeben.
+  version: "1.0.1"
   contact:
     name: "AndreasFischer1985"
     email: "[email protected]"