Änderungen
Was sich an der Integrations-API und an dieser Dokumentation geändert hat.
Neue Einträge stehen oben. Den Verlauf gibt es auch als RSS-Feed.
Integrationen können jetzt Einheiten einbringen und Änderungen verfolgen, ohne alles abzusuchen.
- Ein dritter Schlüssel-Scope,
import: Ein Schlüssel damit lädt Tabellenimporte von Einheiten hoch, ordnet sie zu und lässt sie prüfen (createImport,getImport,listImports,updateImportMapping,validateImport). Das Übernehmen des Imports und das Freigeben seiner Werte bleiben bei Mitgliedern im Portal. Ein mit Schlüssel bereitgestellter Import nennt ihn increated_by_api_key;created_byfehlt dann. - Importvorlagen:
presetbeicreateImportundupdateImportMappingordnet die Spalten eines bekannten ERP-Exports über ihre Spaltennamen zu. - Der Änderungsfeed
listChanges(Scoperead): die Änderungen der Organisation, älteste zuerst, ohne Werte, Handelnde oder personenbezogene Daten, sicher mit gespeichertem Cursor abzufragen. - Neue Integrationsanleitungen: das Sicherheitsmodell, fünf Abläufe, iPaaS, Standards und eine Seite je ERP-System aus dem ERP-Register, mit Angabe, wie und wann jede Schnittstelle geprüft wurde.
Die Entwicklerdokumentation zieht unter /docs/ um und ersetzt die bisherige Seite /api-docs (die auf die
API-Referenz weiterleitet).
- Erste Schritte, Konzepte, Anleitungen und Rezepte auf Deutsch und Englisch.
- Die API-Referenz wird aus dem veröffentlichten Vertrag erzeugt, mit Playground, Codebeispielen in cURL, JavaScript, Python und Go und dem Vertrag zum Herunterladen (JSON, YAML).
- Jede Seite gibt es als Markdown (die Adresse der Seite plus
.md), dazullms.txtundllms-full.txtfür Sprachmodelle.
Adressen folgen dem Format ihres europäischen Landes. Alle Änderungen sind kompatibel.
Addresserhältextra_line(die zweite Adresszeile: Gebäude, Etage, c/o) undregion(die Verwaltungseinheit, wo das Adressformat des Landes eine hat). Beide sind optional und erscheinen in den Standorten vonlistFacilitiesund im öffentlichen Profil des Wirtschaftsakteurs in Pässen.listFacilitiesliefert außerdemplace_idundconfirmed_source: wie ein Mitglied die Adresse eingegeben hat (von Hand, aus der Adresssuche oder durch die Adressprüfung bestätigt). Beide stehen nie in signierten Snapshots oder öffentlichen Pässen.- Der neue Problem-Code
address_lookup_unavailable(503) gehört zur Adresssuche des Portals, die keine API-Schlüssel annimmt.
Veröffentlicht wird nur noch der Teil des Vertrags, den Integrationen nutzen können: die 32 Operationen, die
einen API-Schlüssel annehmen, und die 5 öffentlichen Pass-Abfragen. Anmeldung, Sitzungen, Schlüsselverwaltung
und alle anderen Operationen des Portals stehen nicht mehr in /api/v1/openapi.json und .yaml; sie können
sich ohne Ankündigung ändern.
- API-Schlüssel der Organisation (
Authorization: Bearer bp_live_…) mit den Scopesreadundcondition. Inhaberinnen und Inhaber legen Schlüssel im Portal an; ein Schlüssel hat die Rechte eines Betrachters. - Mit
conditionmelden Batteriemanagementsysteme und Servicepartner Zustandsdaten (updateCondition) und Lebenszyklus-Ereignisse (createLifecycleEvent). - Grenzen: 600 Anfragen pro Minute für alle Schlüssel einer Organisation zusammen, 30 Versuche je 15 Minuten
für unbekannte Schlüssel, 300 öffentliche Abfragen pro Minute und Adresse;
429mitRetry-After.