Authentifizierung

Zur Authentifizierung bei der Dastra-API müssen Sie Folgendes verwenden

Erhalt des geheimen API-Schlüssels

Die Dastra REST-API verwendet API-Schlüssel zur Authentifizierung jeder Anfrage. Sie können Ihre Schlüssel in der Konfigurationsoberfläche Ihrer Organisation verwalten.

Sie können einen API-Schlüssel für einen bestimmten Mandanten oder die gesamte Organisation verwenden.

Ihr API-Schlüssel ermöglicht viele Aktionen, daher sollten Sie ihn sorgfältig aufbewahren. Teilen Sie Ihren geheimen Schlüssel nicht in öffentlichen Bereichen von Anwendungen wie GitHub, clientseitigem Code usw.

Wenn Sie die OAuth2-Authentifizierung im Modus "authorization_code" verwenden möchten, müssen die Weiterleitungs-URL(s) sowie die autorisierten CORS-Ursprünge korrekt konfiguriert werden.

API-Schlüssel (X-API-Key)

Zur Authentifizierung ist die einfachste Methode die Verwendung eines HTTP-Headers X-API-Key, der den privaten Schlüssel Ihres API-Schlüssels enthält, wie im folgenden Beispiel:

curl -X 'GET' \
  'https://api.dastra.eu/me' \
  -H 'accept: */*' \
  -H 'X-API-Key: <your private key here>'

OAuth2 "Authorization code" Flow

Authorization

Die Autorisierungsphase erfolgt durch Aufruf der folgenden URL:

https://account.dastra.eu/connect/authorize?
    response_type=code&
    client_id={YOUR_CLIENT_ID}&
    redirect_uri=https://YOUR_APP/callback&
    scope=api1+offline_access&
    state={STATE}

Parameter

Parameter Name	Description
response_type	code
client_id	Der öffentliche Schlüssel Ihres in Ihrem Dastra-Konto konfigurierten API-Schlüssels
redirect_uri	Die im Dastra-API-Schlüssel konfigurierte URL. Sie werden nach Abschluss des Autorisierungsprozesses automatisch auf diese Seite weitergeleitet
scope	api1 => erforderlich offline_access => um ein refresh_token zu erhalten (lange Sitzungen)
state	Ein von Ihrer Anwendung generierter zufälliger Schlüssel, der Cross-Site-Request-Forgery-Angriffe (CSRF) verhindert, siehe Mitigate CSRF Attacks With State Parameters. Client-Bibliotheken handhaben dies schnell

OAuth2 "Client credential" Flow

Authentifizierungsmethode

Die API-Authentifizierung erfolgt mithilfe des OAuth2-Protokolls unter Verwendung des "Client credential"-Flows. Dieser Authentifizierungsmodus darf ausschließlich für Server-zu-Server-Anfragen verwendet werden und darf keinesfalls browserseitig eingesetzt werden (z. B. SPA in JavaScript).

Token abrufen

POST https://account.dastra.eu/connect/token

Perform a token request using BASIC Headers

Headers

Name	Type	Description
*	Authorization	Basic {base64("{PublicKey}:{PrivateKey}")}

Request Body

Name	Type	Description
*	grant_type	client_credentials
*	scope	api1

200: OK The access_token necessary to perform operations on the REST API

{
  "access_token":"tNQoqsSePv0DnSSNVJv1aDxzSFh9H2z3YBKtuBKqWAU",
  "expires_in":3600,
  "token_type":"Bearer",
  "scope":"api1"
}

Sobald Sie ein access_token erhalten haben, können Sie anschließend jeden Endpunkt der REST-API mit diesem Zugriffstoken aufrufen, indem Sie es als "Bearer Token" übergeben.

Zum Beispiel, um die Liste Ihrer Mandanten abzurufen:

GET https://api.dastra.eu/v1/workspaces

Liste der Dastra-Mandanten abrufen

Headers

Name	Type	Description
*	Authorization	Bearer {access_token}

200: OK

{
  "items": [
    {
      "id": 1,
      "tenantId": 1,
      "label": "My data company",
      "logoUrl": null,
      "state": "Active",
      "permissions": null,
      "dataSubjectArchivedRetentionDays": null,
      "nbEntities": 1
    },
    {
      "id": 2,
      "tenantId": 1,
      "label": "My test workspace",
      "logoUrl": null,
      "state": "Active",
      "permissions": null,
      "dataSubjectArchivedRetentionDays": null,
      "nbEntities": 1
    },
    {
      "id": 3,
      "tenantId": 1,
      "label": "My experimentation workspace",
      "logoUrl": null,
      "state": "Active",
      "permissions": null,
      "dataSubjectArchivedRetentionDays": null,
      "nbEntities": 0
    }
  ],
  "total": 3
}

Alle Anfragen müssen über HTTPS und immer serverseitig erfolgen. Anfragen ohne Authentifizierung schlagen mit dem Fehlercode 401 fehl.

Die API-Referenz finden Sie hier: https://api.dastra.eu/swagger/index.html