API-Authentifizierung

Geändert am Fr, 4 Jul um 4:55 NACHMITTAGS

Die API verwendet OpenID Connect (OIDC) als Authentifizierungsprotokoll. Es handelt sich um einen bekannten Standard und einen Teilbereich von OAuth 2.0. Es gibt viele Datenbanken, die bei der Implementierung eines Clients in den meisten Sprachen nützlich sein können.


Einen Zugriffstoken abrufen

Der Client verwendet eine Client-ID und einen geheimen Client-Schlüssel, um sich zu identifizieren, und erhält nach erfolgreicher Authentifizierung einen Zugriffstoken. Bitte fordern Sie die Zugangsdaten für den Zugriff auf die API bei Position Green an.


Zugriffstoken abrufen

POST https://login.positiongreen.com/connect/token

Senden Sie zunächst einen HTTP POST an /connect/token mit den nachstehenden Parametern. grant_type ist "client_credentials" und client_id sowie client_secret wurden für Ihren Client bereitgestellt. 


Wenn der Statuscode 200 ist, enthält die Antwort JSON mit der Eigenschaft access_token. Diese wird in allen Anfragen an die Position Green API verwendet. 


Senden Sie einen HTTP POST an /connect/token mit den folgenden Formularparametern, um einen Zugriffstoken abzurufen.


Pfad-Parameter

BezeichnungArtBeschreibung

client_id

string

Die Client-ID, die Sie von Position Green erhalten haben

client_secret

string

Der geheime Client-Schlüssel, den Sie von Position Green erhalten haben

grant_type

string

Sollte auf client_credentials gesetzt werden



{
    "access_token":"<access token>",
    "expires_in":3600,
    "token_type": "Bearer"
}

Beispiel: Einen Zugriffstoken mittels curl abrufen


Führen Sie das folgende Script in einer Zeile aus und ersetzen Sie client_secret, client_id und api-url.

curl --location --request POST 
--header "Content-Type: application/x-www-form-urlencoded" 
--data-urlencode "grant_type=client_credentials"
--data-urlencode "client_secret=<client_secret>"
--data-urlencode "client_id=<client_id>"
"<api-url>/connect/token"

Beispiel: Einen Zugriffstoken mittels C# abrufen


var client = new HttpClient(); 
client.BaseAddress = new Uri(loginUrl); 

var data = new Dictionary<string, string> 
{
{"client_id", "your-client-id"},
{"client_secret", "your-client-secret" }, 
{"grant_type", "client_credentials"}, 
};
var response = await client.PostAsync( 
"/connect/token", 
new FormUrlEncodedContent(data)); 

var stringResponse = await response.Content.ReadAsStringAsync();


Antwort


{
   "access_token": "<access token>",
   "expires_in": 3600,
   "token_type": "Bearer"
}

Alternativ können Sie auch client_id und secret im Header verwenden.


Statt des Abrufs eines Zugriffstokens können Sie auch bei jedem Zugriff auf eine Operation in der Position Green API die Client-ID und den geheimen Client-Schlüssel senden. In diesem Artikel erfahren Sie, wie Sie API-Zugangsdaten erzeugen.


Senden Sie Client-ID und Client-Secret.


BezeichnungWert

client_id

Ihre Client-ID

client_secret

Ihr geheimer Client-Schlüssel



War dieser Artikel hilfreich?

Das ist großartig!

Vielen Dank für das Feedback

Leider konnten wir nicht helfen

Vielen Dank für das Feedback

Wie können wir diesen Artikel verbessern?

Wählen Sie wenigstens einen der Gründe aus
CAPTCHA-Verifikation ist erforderlich.

Feedback gesendet

Wir wissen Ihre Bemühungen zu schätzen und werden versuchen, den Artikel zu korrigieren