API-Authentifizierung

Geändert am Mo, 9 Jun um 3:49 NACHMITTAGS

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


Wie man ein Zugangstoken erhält

Der Client verwendet eine Id und ein Geheimnis, um sich zu identifizieren, und erhält nach erfolgreicher Authentifizierung ein Zugriffstoken. Bitte wenden Sie sich an Position Green, um die Zugangsdaten für den Zugriff auf die API zu erhalten.


Zugriffstoken erhalten

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

Senden Sie zunächst einen HTTP POST an/connect/token mit den folgenden Parametern. Wenn grant_type "client_credentials" ist und client_id und client_secret für Ihren Kunden angegeben wurden. 


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


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


Pfad-Parameter

NameTypBeschreibung

client_id

some translation

Die Id des Kunden, die Sie von Position Green erhalten haben

kunden_geheimnis

some translation

Das Kundengeheimnis, das Sie von Position Green erhalten haben

Förderungsart

some translation

Sollte auf client_credentials gesetzt werden



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

Beispiel: Abrufen eines Zugriffstokens unter Verwendung von curl


Führen Sie das Folgende 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 für die Verwendung eines Zugriffstokens in C#


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 in der Kopfzeile verwenden


ArtikelAnstatt ein Zugriffstoken zu erhalten, ist es möglich, die Id und das Geheimnis des Clients zu senden, wenn auf Vorgänge in Position Green API zugegriffen wird. Um API-Anmeldeinformationen zu generieren, lesen Sie diesen Artikel.


Senden Sie die Id und das Geheimnis des Kunden


NameWert

client_id

Ihre Id des Kunden

kunden_geheimnis

Ihr Kundengeheimnis



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