API Connect-REST-APIs

• Einen habenAPI Connect Benutzer, der Mitglied einer Anbieter- oder Verbraucherorganisation ist.
• App-Anmeldeinformationen: Eine Client-ID und ein Client-Geheimnis. Diese Zugangsdaten erhalten Sie bei der API-Manager UI oder von IhremAPI Connect Administrator.

1. Im API-Manager Klicken Sie auf der Startseite der Benutzeroberfläche auf das Toolkit herunterladen Fliese.
2. Laden Sie die Toolkit-Anmeldeinformationen (Sie müssen den CLI- oder API-Designer nicht herunterladen).
3. Öffnen Sie die heruntergeladenecredentials.json Datei, um die Plattform- und Verbraucherendpunkte sowie die Anmeldeinformationen zum Aufrufen von APIs auf diesen Endpunkten anzuzeigen:

   {
     "cloud_id": "e8fcdec3-bfb9-44bd-bf90-03d8639c4916",
     "toolkit": {
       "endpoint": "https://example-platform-api.ibm.com/api",
       "client_id": "7ad7b6c5-fa07-4222-808d-8de7266dcd1a",
       "client_secret": "b7127e44-4811-48be-be9d-6591302de04a"
     },
     "consumer_toolkit": {
       "endpoint": "https://example-consumser-api.ibm.com/consumer-api",
       "client_id": "3b10e0db-1cd4-4aa8-af02-51a83e334f1c",
       "client_secret": "a5a672b7-e3b2-4d2b-984b-4059ea82ae65"
     },
     "governance": {
       "endpoint": "https://example-governance.ibm.com/governance",
       "client_id": "ba48537c-7a6e-4232-92b6-ae67ad764933",
       "client_secret": "790d8a6d-e323-46bd-a05c-3d212e93d794"
     },
     "discovery": {
       "endpoint": "https://example-discovery.ibm.com/discovery",
       "client_id": "d872a2f4-bc6e-4e91-b187-bbb5b99d4605",
       "client_secret": "c0b5ddf9-58e6-4246-88de-243ce217731a"
     }
   }

   Die Endpunkte und Anmeldeinformationen, die in dercredentials.json Datei sind

   1. toolkit: Der API-Endpunkt der Plattform. Verwenden Sie dies für API-Aufrufe im Geltungsbereich der Anbieterorganisation.
   2. consumer_toolkit: Der Consumer-API-Endpunkt. Verwenden Sie dies für API-Aufrufe im Rahmen der Verbraucherorganisation, z. B. zum Erstellen einer App in einer Verbraucherorganisation.
   3. governance: Siehe die API-Verwaltung Besonderheit.
   4. discovery: Siehe die API-Erkennung Besonderheit.

curl -v -k -X POST -d '{"api_key": "<api_key>", "client_id": "<client_id>", "client_secret": "<client_secret>", "grant_type": "api_key"}' -H 'Content-Type: application/json' -H 'Accept: application/json' https://<management_server_platform_api_endpoint>/api/token

• <api-key> ist der API-Schlüssel, den Sie generiert haben.
• <client_id> ist die Client-ID aus dem Abschnitt "Toolkit" der Datei credentials.json oder wie von Ihrem API Connect Cloud-Administrator angegeben.
• <client_secret> ist das Client-Geheimnis aus dem Abschnitt "Toolkit" der Datei credentials.json oder wie von Ihrem API Connect Cloud-Administrator bereitgestellt.
• provider/default-idp-2für Mitglieder von Anbieterorganisationen.
• verbraucher: <provider org>:<catalog>/<catalog>-idp für Mitglieder von Verbraucherorganisationen.

{
    "access_token": "<bearer_token>",
    "token_type": "Bearer",
    "expires_in": 28800
}

curl -k -X <HTTP Method> --url 'https://<rest api endpoint>/<api path> -H 'Authorization: Bearer <bearer_token>'

-H 'X-IBM-Consumer-Context: <provider org>.<catalog>'

Holen Sie sich eine Liste der Anbieterorganisationen

Verwenden Sie ein Inhabertoken, das mit den Anmeldeinformationen eines Mitglieds der Anbieterorganisation erstellt wurde, und geben Sie den API-Endpunkt der Plattform an:

curl -k -X GET --url 'https://<platform api endpoint>/api/orgs' -H 'Authorization: Bearer <bearer_token>'

Abrufen einer Liste der Apps in einem Katalog

Verwenden Sie ein Bearer-Token, das mit den Anmeldeinformationen eines Mitglieds der Verbraucherorganisation erstellt wurde, geben Sie den API-Endpunkt des Verbrauchers an und schließen Sie dieX-IBM-Consumer-Context Header:

curl -k -X GET --url 'https://<consumer api endpoint>/consumer-api/orgs/<consumer org>/apps' -H 'X-IBM-Consumer-Context: <provider org>.<catalog>' -H 'Authorization: Bearer <bearer_token>'

Rufen Sie Analytics-API-Ereignisdaten für einen Katalog ab:

curl -k -X GET --url 'https://<platform api endpoint>/analytics/<analytics service>/orgs/<provider org>/events' -H 'Authorization: Bearer <bearer_token>'

Für Analysedaten auf Anbieterorganisationsebene verwenden Sie <Plattform-API-Endpunkt>.

Für Analysedaten im Rahmen der Verbraucherorganisation verwenden Sie <Consumer-API-Endpunkt>, Und/consumer-analytics anstatt/analytics . Berücksichtigen Sie auch dieX-IBM-Consumer-Context Header. Beispiel:

curl -k -X GET --url 'https://<consumer api endpoint>/consumer-analytics/orgs/<consumer org>/dashboard' -H 'X-IBM-Consumer-Context: <provider org>.<catalog>' -H 'Authorization: Bearer <bearer_token>'

Weitere Informationen zum Abfragen von Analysedaten mit der REST-API finden Sie unter Verwenden der Analytics-REST-API.

• HTTP 403: Verboten. Überprüfen Sie, ob Ihr Bearer-Token mit den richtigen Anmeldeinformationen für den API-Aufruf erstellt wurde.
• HTTP 404: Nicht gefunden. Überprüfen Sie, ob Ihr API-Endpunkt URL und der Pfad korrekt sind. Führen Sie einen Consumer-API-Aufruf am API-Endpunkt der Plattform durch?
• HTTP 401: Nicht autorisiert. Überprüfen Sie, ob Ihr Trägertoken korrekt und nicht abgelaufen ist. Wenn dies zurückgegeben wird, wenn Sie ein Bearer-Token anfordern, überprüfen Sie, ob dasusername ,password ,realm ,client_id , Undclient_secret sind richtig.