Korzystanie z Acurl

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Narzędzie acurl⁽¹⁾ zapewnia wygodną otoczkę dla standardowego polecenia curl. acurl:

• Wymiana danych logowania w usłudze 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 tokena dostępu jest użycie narzędzia get_token.

Zainstaluj acurl

Zanim zaczniesz korzystać z acurl, musisz go zainstalować.

składnia acurl

Narzędzie acurl używa tej składni:

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

lub

acurl API_URL -p PASSCODE

Gdzie:

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 opcji wymienionych powyżej acurl akceptuje wszystkie opcje 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:

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 narzędzia 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

acurl -u username

Narzędzie acurl zakoduje Twoje dane logowania i od czasu do czasu poprosi o dodatkowe dane logowania, które są wymagane do uzyskania nowych par tokenów.

Narzędzia acurl można też używać do zastępowania curl w przypadku użytkowników maszyn. Więcej informacji znajdziesz w artykułach OAuth2 dla użytkowników maszynowych i Użytkownicy maszynowi w strefach SAML.

Pierwsze wywołanie acurl

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 pokazuje początkowe wywołanie funkcji acurl w celu uzyskania szczegółowych informacji o organizacji za pomocą punktu końcowego Get organization:

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 ~/.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.

Ta prośba umożliwia uzyskanie szczegółowych informacji o organizacji „ahamilton-eval”. Pełną listę Punkty końcowe interfejsu API Edge znajdziesz w dokumentacji interfejsu API Apigee Edge.

⁽¹⁾ 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.