API hívása előfizetői azonosítóval

  • 5 perc

Egy API közzétételekor gyakran érdemes valamilyen szinten kézben tartani, hogy ki férhet hozzá az API-hoz az átjárón keresztül. Az előfizetési kulcsok az API-khoz való hozzáférés korlátozásának egyik módja.

Itt megtudhatja, hogyan használhat előfizetési kulcsokat az API-k védelméhez.

Előfizetések és azonosítók

Az API-k védelméről előfizetői azonosítókkal gondoskodhat.

Megjegyzés:

Éles API Management-környezetekben az előfizetési kulcsot általában más mechanizmusokkal kombinálva védi az API-kat a jogosulatlan használattól, például a tanúsítványhitelesítéstől vagy az OAuth 2.0-s hitelesítéstől. Ezek nem tartoznak a modul hatókörébe.

Az előfizetési kulcs egy egyedi, automatikusan létrehozott sztring, amelyet az ügyfélkérés fejléceiben vagy az URL-cím lekérdezési sztringjeként ad át. A kulcs közvetlenül kapcsolódik egy előfizetéshez, amely különböző területekre terjedhet ki, és részletes vezérlést biztosít az engedélyek és szabályzatok felett. A fő előfizetési hatókörök a következők:

  • Minden API
  • Egyetlen API
  • Egy termék

A védett API-t hívó alkalmazásoknak tartalmazniuk kell a kulcsot a kérelemben.

Ezeket az előfizetési kulcsokat bármikor újra létrehozhatja. Például újragenerálhatja az előfizetési kulcsokat, ha azt gyanítja, hogy a kulcs meg lett osztva jogosulatlan felhasználókkal.

Subscription keys.

Minden előfizetéshez két azonosító tartozik, egy elsődleges és egy másodlagos. Két kulcs használata megkönnyíti a kulcsok újragenerálását. Ha például módosítani szeretné az elsődleges azonosítót, és el szeretné kerülni az állásidőt, a másodlagos azonosítót használhatja az alkalmazásokban.

Azokban a termékekben, ahol engedélyezettek az előfizetések, meg kell adnia egy azonosítót, amikor a termékben lévő API-kat hív. Fejlesztőként egy előfizetési kérés elküldésével szerezhet be azonosítót. Ez a folyamat az API Management munkafolyamat alapvető része.

Megjegyzés:

Az API Management munkafolyamat alapvető része, hogy új felhasználókat hoz létre, és megadja nekik az előfizetési kulcsokat, hogy hozzáférhessenek az API-hoz, de nem tartozik a modul hatókörébe.

API hívása előfizetői azonosítóval

Az alkalmazásoknak minden HTTP-kérésbe bele kell foglalniuk egy érvényes azonosítót, amikor előfizetéssel védett API-végpontokra irányuló hívásokat indítanak. Az azonosítók a kérelem fejlécében vagy az URL-ben, lekérdezési sztringként továbbíthatók.

Az alapértelmezett fejléc neve Ocp-Apim-Subscription-Key, és az alapértelmezett lekérdezési sztring a subscription-key.

Az API-hívások teszteléséhez használhatja a fejlesztői portált (ha elérhető a szolgáltatási szinten), egy parancssori eszközt, például a curlt vagy más eszközöket, például a Postmant.

Íme egy példa egy GET-kérésre, amely a curl paranccsal ad át egy kulcsot a kérés fejlécében:

curl --header "Ocp-Apim-Subscription-Key: <key string>" https://<apim gateway>.azure-api.net/api/path

Példa a curl parancsra, amelyet lekérdezési sztringként helyez azonosítót az URL-címbe:

curl https://<apim gateway>.azure-api.net/api/path?subscription-key=<key string>

Ha a kulcs nincs átadva a fejlécben, vagy lekérdezési sztringként az URL-címben, 401 hozzáférés megtagadva választ kap az API-átjárótól.