Ta strona została przetłumaczona przez Cloud Translation API.

Korzystanie z Acurl

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Narzędzie acurl⁽¹⁾ zapewnia wygodne otoczenie standardowego polecenia curl. acurl:

Wymienia dane logowania Apigee na token dostępu OAuth2.
Wykrywa ważność tokena dostępu i używa tokena odświeżania, aby pobrać nowy token dostępu.
przekazuje ten token w nagłówku Authorization żądania API.

Tokenów dostępu używasz do wywoływania punktów końcowych interfejsu Edge API za pomocą protokołu OAuth2, w tym przepływów pracy LDAP i SAML.

Jeśli uzyskujesz dostęp do interfejsu Edge API za pomocą protokołu OAuth2, ale nie używasz acurl, musisz samodzielnie uzyskać token dostępu i dodać go do nagłówka żądania do interfejsu API. Token dostępu możesz też uzyskać za pomocą narzędzia get_token.

Zainstaluj adres acurl

Aby móc używać pakietu acurl, musisz go zainstalować.

składnia acurl

Narzędzie acurl używa następującej składni:

acurl API_URL -u USERNAME:PASSWORD [-m MFACODE]

lub

acurl API_URL -p PASSCODE

Gdzie:

Option	Wymagana?	Opis
`API_URL`	Wymagany	Punkt końcowy Apigee Edge API. Pełną listę punktów końcowych znajdziesz w dokumentacji interfejsu Apigee Edge API.
`USERNAME`	Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod 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ć nazwę użytkownika lub kod dostępu. Nie musisz ponownie przekazywać swojego adresu e-mail, dopóki tokeny dostępu i odświeżenia nie wygasną. Jeśli przechowujesz tokeny w pamięci podręcznej dla więcej niż 1 użytkownika, nazwę użytkownika musisz podawać w każdym wywołaniu.
`PASSWORD`	Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod dostępu.	Hasło do Twojego konta Apigee. Jeśli pominiesz hasło, zobaczysz prośbę o jego podanie przy pierwszym użyciu `acurl` oraz przy kolejnych wywołaniach bez prawidłowego tokena odświeżania. Jeśli nie chcesz używać hasła bezpośrednio w poleceniu, możesz zamiast hasła podać jednorazowy kod dostępu.
`MFACODE`	Opcjonalny	Tymczasowy 6-cyfrowy kod uwierzytelniania wielopoziomowego (MFA). Ten kod jest wymagany, jeśli korzystasz z usługi `-u` i masz włączone MFA. W przypadku pominięcia zostanie wyświetlony monit (chyba że w trybie dostępu do hasła). Jeśli nie masz włączonego MFA lub korzystasz z procesu opartego na skryptach, możesz określić `-m ""`, aby unikać monitów.
`PASSCODE`	Opcjonalna. Wymagana jest kombinacja nazwy użytkownika i hasła lub kod dostępu.	Jednorazowy kod dostępu, którego możesz używać zamiast hasła. Kod dostępu jest wymagany podczas uwierzytelniania u dostawcy tożsamości SAML. Kod może służyć do uwierzytelniania u dostawcy tożsamości LDAP.

Na przykład:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval
acurl 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 powyższych opcji acurl akceptuje wszystkie opcje curl. Za pomocą standardowych opcji curl możesz na przykład przekazywać nagłówki, określać czasownik HTTP, dodawać treść i włączać szczegółowość:

Option	`acurl meaning`	`curl meaning`
-U	`username`	`username`
-m	`MFA code`	`max time` (musi używać długiej formy `--max-time`)
-p	`passcode`	`proxy tunnel` (musi używać długiej formy `--proxytunnel`)
-v	`verbose`	`verbose`
-godz.	`help`	`help` (musi używać długiej formy `--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 na podstawie wywołanego punktu końcowego interfejsu Edge API. Dodatkowo acurl przechowuje tokeny dostępu i odświeżenia w ~/.sso-cli.

Możesz nadal nawiązywać połączenia bez wpisywania danych logowania (hasła i opcjonalnego MFA lub kodu dostępu), dopóki nie wygasną zarówno token dostępu, jak i 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 potrzebę ręcznego kodowania danych logowania. Gdy pobierzesz i zainstalujesz narzędzie, możesz zastąpić:

curl -u username

tymi:

acurl -u username

Narzędzie acurl zakoduje Twoje dane logowania i od czasu do czasu wyświetli prośbę o podanie dodatkowych danych logowania wymaganych w celu uzyskania nowych par tokenów.

Narzędzie acurl może też zastąpić curl w przypadku użytkowników komputerów. Więcej informacji znajdziesz w artykułach Protokół OAuth2 dla użytkowników komputerów i Użytkownicy komputerów w strefach SAML.

Wywołanie acurl po raz pierwszy

Przy pierwszym wywołaniu interfejsu API za pomocą acurl podajesz swoje dane logowania do Apigee (nazwę użytkownika i hasło do konta Apigee lub kod dostępu), aby acurl mógł je wymienić na token dostępu i token odświeżania.

Poniższy przykład przedstawia wstępne połączenie z acurl w celu uzyskania informacji o organizacji za pomocą punktu końcowego Pobierz organizację:

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 wstawia go do wywołania punktu końcowego interfejsu Edge API:

curl -H "Authorization: Bearer oauth2_access_token" ...

Token dostępu jest przechowywany lokalnie w regionie ~/.sso-cli i używany przy kolejnych wywołaniach.

Po wygaśnięciu tokena dostępu acurl automatycznie używa tokena odświeżania, aby uzyskać nowy. Gdy token odświeżania wygaśnie, acurl poprosi o podanie danych logowania Apigee.

To żądanie zawiera szczegółowe informacje o organizacji „ahamilton-eval”. Pełną listę punktów końcowych interfejsu Edge API znajdziesz w dokumentacji interfejsu Apigee Edge API.

⁽¹⁾ Prawa autorskie 2023 Google LLC
Narzędzie acurl jest dostępne jako „Oprogramowanie” w ramach umowy regulującej korzystanie z Google Cloud Platform, w tym ze Szczegółowymi warunkami korzystania z usługi dostępnymi na https://cloud.google.com/terms/service-terms.