Hier werden die wichtigsten Schritte für die Institutionen welche APIs bereitstellen (Provider) und die Institutionen welche APIs abrufen (Consumer) beschrieben.
Provider:
- Provider muss die APIs entsprechend der Dokumentation unter „API Endpoints“ umsetzen.
- Provider schickt eine Email an ris-synergy@tuwien.ac.at mit folgenden Informationen:
- ID der Institution (MinisteriumsID)
- Acronym der Institution
- Link zum Authorization Server, der den OAuth 2 Token ausliefert (OAUTH_SERVER_URL) der Institution, z.B: https://oauth2-staging.aau.at/oauth/token
- Nähere Infos zum Authorization Server finden sich unter API Sicherheit.
- Link zum Info Endpoint, z.B. https://cris-staging.aau.at/ris-synergy/info/v1/oauth/info/
- Der Info Endpoint listet die API Endpoints der angebotenen APIs (siehe RIS-Synergy Netzwerk).
- Kontakt-Email zwecks Austausch der Credentials mit anderen Partnern
- Liste mit den Namen der angebotenen API’s (z.B. Funding, Project)
- RIS Technik Team fügt Eintrag in der Registry und auf im Tab „Angebundene Institutionen“ der entsprechenden APIs unter „API Endpoints“ hinzu.
- Provider testet die API’s mit ausgewählten Partnern. Die Partner müssen dazu die Punkte unter „Consumer“ durchgehen.
Consumer:
- Consumer nimmt Kontakt mit den Providern der APIs auf um die Credentials auszutauschen:
- In der Dokumentation werden im Tab „Angebundene Institutionen“ der entsprechenden API unter „API Endpoints“ alle angebotenen Schnittstellen pro Institution gelistet.
- Kontakt Email-Adressen finden sich in der Registry (https://forschungsdaten.at/registry/registry.json) für die jeweilige Institution.
- Austausch der Credentials in einer sicheren Umgebung / gesicherter Kommunikationskanal
- Consumer testet die APIs (können der Info Endpoint und die gewünschten APIs mit den ausgetauschten Credentials aufgerufen werden?).
- Nähere Infos zur Autorisierung finden sich unter API Sicherheit.
- Consumer verwendet die API mit Hilfe der API-Beschreibung unter „API Endpoints“.