Przeglądasz dokumentację Apigee Edge.
Przejdź do
Dokumentacja Apigee X. informacje.
Narzędzie acurl
(1) zapewnia udogodnienie w postaci standardowego kodu curl
. acurl
:
- Wymienia Twoje dane logowania Apigee na token dostępu OAuth2.
- Określa, kiedy token dostępu wygasł, i używa tokena odświeżania, aby uzyskać nowy token dostępu.
- Karty stanowiące tokeny w nagłówku
Authorization
żądania do interfejsu API.
Tokenów dostępu możesz używać do wywoływania punktów końcowych interfejsu Edge API za pomocą OAuth2, w tym: Przepływy pracy LDAP i SAML.
Jeśli uzyskujesz dostęp do interfejsu Edge API za pomocą OAuth2, ale nie używasz interfejsu acurl
, musisz
pobierz token dostępu i samodzielnie dodaj go do nagłówka żądania do interfejsu API. Jednym ze sposobów uzyskania
token dostępu jest używany przy użyciu narzędzia get_token.
Zainstaluj acurl
Zanim zaczniesz korzystać z acurl
, musisz
zainstaluj ją.
składnia acurl
Narzędzie acurl
korzysta z tej składni:
acurl API_URL -u USERNAME:PASSWORD [-m MFACODE]
lub
acurl API_URL -p PASSCODE
Gdzie:
Opcja | Wymagana? | Opis |
---|---|---|
API_URL | Wymagany | Punkt końcowy interfejsu Apigee Edge API. Pełną listę punktów końcowych znajdziesz w dokumentacji interfejsu API Apigee Edge. |
USERNAME | Opcjonalna. Wymagane jest podanie kombinacji nazwy użytkownika i hasła lub kodu dostępu. | Twoja nazwa użytkownika Apigee, czyli zwykle adres e-mail powiązany z Twoim kontem Apigee.
Przy pierwszym połączeniu z numerem get_token musisz podać swoją nazwę użytkownika lub kod dostępu.
Nie musisz przekazywać swojej poczty e-mail.
do czasu upływu ważności tokenów dostępu i odświeżania. Jeśli buforujesz tokeny
dla więcej niż jednego użytkownika musisz podać swoją nazwę użytkownika w każdym wywołaniu. |
PASSWORD | Opcjonalna. Wymagane jest podanie kombinacji nazwy użytkownika i hasła lub kodu dostępu. | Hasło do Twojego konta Apigee. Jeśli pominiesz hasło, pojawi się prośba o podanie hasła
przy pierwszym użyciu acurl i przy kolejnych połączeniach bez prawidłowego
token odświeżania. Jeśli nie chcesz używać hasła bezpośrednio w poleceniu, możesz użyć polecenia
jednorazowego kodu dostępu zamiast hasła. |
MFACODE | Opcjonalny | Tymczasowy 6-cyfrowy wielopoziomowy wieloskładnikowy
(MFA). Ten kod jest wymagany, jeśli korzystasz z usługi -u i masz włączone MFA.
Jeśli pytanie zostanie pominięte (chyba że jest to tryb kodu dostępu), pojawi się odpowiedni komunikat. Jeśli nie masz włączonego MFA lub masz przepływ skryptu,
możesz wpisać -m "" , aby uniknąć próśb. |
PASSCODE | Opcjonalna. Wymagane jest podanie kombinacji nazwy użytkownika i hasła lub kodu dostępu. | jednorazowego kodu dostępu, którego możesz użyć zamiast hasła. Kod dostępu jest wymagany podczas uwierzytelniania przy użyciu dostawcy tożsamości SAML i może być używany aby uwierzytelnić się u dostawcy tożsamości LDAP. |
Na przykład:
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-evalacurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com -p 424242
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval -u ahamilton@apigee.com:mypassw0rd -m 123456
Oprócz wymienionych powyżej opcji acurl
akceptuje wszystkie te warunki: curl
. Możesz na przykład przekazywać nagłówki, określać czasowniki HTTP, dodawać treść i włączać
szczegółowość przy użyciu standardowych opcji curl
:
Opcja | acurl meaning |
curl meaning |
---|---|---|
-U | username |
username |
–M | MFA code |
max time (musi używać długiego formatu: --max-time ) |
–P | passcode |
proxy tunnel (musi używać długiego formatu: --proxytunnel ) |
-v | verbose |
verbose |
–godz. | help |
help (musi używać długiego formatu: --help ) |
acurl -v -X POST -H 'Content-Type: application/json' \ https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apiproducts/myproduct/attributes/attr \ -u ahamilton@apigee.com -d '{"value":42}'
Udane wywołanie acurl
zwraca wyniki w zależności od wybranego punktu końcowego interfejsu Edge API
. Dodatkowo acurl
przechowuje zarówno tokeny dostępu, jak i tokeny odświeżania
w aplikacji ~/.sso-cli
.
Możesz nadal nawiązywać połączenia bez wpisywania danych logowania (hasła i opcjonalnie MFA lub kodu dostępu). dopóki token dostępu i parametr token odświeżania zgodnie z opisem w sekcji Wygaśnięcie tokena.
Migracja z curl
Jeśli używasz curl
, migracja do narzędzia acurl
jest prosta i
eliminuje konieczność ręcznego kodowania danych logowania. Po pobraniu i zainstalowaniu narzędzia można
zamień:
curl -u username
z:
acurl -u username
Narzędzie acurl
zakoduje
danych logowania i od czasu do czasu pojawia się prośba o podanie dodatkowych danych logowania wymaganych do uzyskania nowych par tokenów.
Narzędzie acurl
może też zastąpić interfejs curl
w przypadku użytkowników komputerów. Aby dowiedzieć się więcej,
Więcej informacji znajdziesz w artykułach OAuth2 dla użytkowników maszyn i Użytkownicy komputerów w strefach SAML.
Wywołanie acurl po raz pierwszy
Przy pierwszym wywołaniu interfejsu API za pomocą funkcji acurl
musisz podać swoje dane logowania Apigee (parametr acurl
nazwę użytkownika i hasło do konta Apigee lub hasło), tak aby
acurl
może je wymienić na token dostępu i token odświeżania.
Ten przykład przedstawia pierwsze połączenie z użyciem funkcji acurl
, aby uzyskać szczegółowe informacje na temat
organizacji za pomocą narzędzia Get
Punkt końcowy organizacji:
acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \ -u ahamilton@apigee.com Enter the password for user 'ahamilton@apigee.com':[hidden input]
Enter the six-digit code (no spaces) if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:1a2b3c
{ "createdAt" : 1491854501264, "createdBy" : "noreply_iops@apigee.com", "displayName" : "ahamilton", "environments" : [ "prod", "test" ], "lastModifiedAt" : 1491854501264, "lastModifiedBy" : "noreply_iops@apigee.com", "name" : "ahamilton", "properties" : { "property" : [ { "name" : "features.isSmbOrganization", "value" : "false" }, { "name" : "features.isCpsEnabled", "value" : "true" } ] }, "type" : "trial" }
Narzędzie acurl
pobiera token dostępu i umieszcza go w wywołaniu funkcji
Punkt końcowy interfejsu Edge API:
curl -H "Authorization: Bearer oauth2_access_token" ...
Token dostępu jest przechowywany lokalnie w organizacji ~/.sso-cli
i używany do:
kolejnych wywołań.
Gdy token dostępu wygaśnie, acurl
automatycznie użyje tokena odświeżania, aby pobrać
nowy token dostępu. Gdy token odświeżania wygaśnie, acurl
poprosi Cię o potwierdzenie
za swoje dane logowania do Apigee.
To żądanie uzyskuje szczegółowe informacje o elemencie „ahamilton-eval” Twojej organizacji. Pełną listę Punkty końcowe interfejsu API Edge znajdziesz w dokumentacji interfejsu API Apigee Edge.
(1) Copyright 2023 Google LLC
Narzędzie acurl
jest udostępniane jako „Oprogramowanie” pod
umowy regulującej korzystanie przez Ciebie z Google Cloud Platform, w tym z Usługi
Szczegółowe warunki są dostępne na stronie https://cloud.google.com/terms/service-terms.