Chính sách Xác minh khóa API

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Nội dung

Chính sách Xác minh khoá API cho phép bạn thực thi quy trình xác minh khoá API trong thời gian chạy, chỉ cho phép ứng dụng có khoá API được phê duyệt sẽ truy cập vào API của bạn. Chính sách này đảm bảo rằng khoá API là hợp lệ, có chưa bị thu hồi và được phê duyệt sử dụng các tài nguyên cụ thể được liên kết với API của bạn của Google dành cho doanh nghiệp.

Mẫu

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.queryparam.apikey" />
</VerifyAPIKey>

curl http://myorg-test.apigee.net/mocktarget?apikey=IEYRtW2cb7A5Gs54A1wKElECBL65GVls

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey" />
</VerifyAPIKey>

curl "http://myorg-test.apigee.net/mocktarget" -H "x-apikey:IEYRtW2cb7A5Gs54A1wKElECBL65GVls"

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="requestAPIKey.key"/>
</VerifyAPIKey>

<ExtractVariables async="false" continueOnError="false" enabled="true" name="SetAPIKeyVar">
    <Source>request</Source>
    <QueryParam name="myKey">
        <Pattern ignoreCase="true">{key}</Pattern>
    </QueryParam>
    <VariablePrefix>requestAPIKey</VariablePrefix>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</ExtractVariables>

<AssignMessage async="false" continueOnError="false" enabled="true" name="accessverifyvars">
    <AssignVariable>
        <Name>devFirstName</Name>
        <Ref>verifyapikey.verify-api-key.developer.firstName</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <AssignVariable>
        <Name>devLastName</Name>
        <Ref>verifyapikey.verify-api-key.developer.lastName</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <AssignVariable>
        <Name>devEmail</Name>
        <Ref>verifyapikey.verify-api-key.developer.email</Ref>
        <Value>ErrorOnCopy</Value>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

verifyapikey.{policy_name}

Giới thiệu về chính sách Xác minh khoá API

Khi nhà phát triển đăng ký ứng dụng trên Edge, Edge sẽ tự động tạo khoá người dùng và cặp bí mật. Bạn có thể xem cặp khoá bí mật và khoá người dùng của ứng dụng trong giao diện người dùng Edge hoặc truy cập chúng từ API Edge.

Tại thời điểm đăng ký ứng dụng, nhà phát triển chọn một hoặc nhiều sản phẩm API để liên kết với ứng dụng, trong đó sản phẩm API là một tập hợp tài nguyên có thể truy cập thông qua proxy API. Sau đó, nhà phát triển chuyển khoá API (khoá người tiêu dùng) như một phần của mọi yêu cầu đối với API trong sản phẩm API được liên kết với ứng dụng. Hãy xem phần Tổng quan về việc xuất bản để biết thêm thông tin.

Bạn có thể dùng khoá API làm mã xác thực hoặc dùng các khoá này để truy cập vào OAuth mã thông báo. Trong OAuth, khoá API được gọi là "client id" (mã ứng dụng khách). Các tên này có thể sử dụng thay thế cho nhau. Xem Trang chủ OAuth để biết thêm thông tin.

Edge tự động điền sẵn một nhóm biến luồng khi thực thi chính sách Xác minh khoá API. Xem Flow biến bên dưới để biết thêm thông tin.

Tham chiếu phần tử

Sau đây là các phần tử và thuộc tính mà bạn có thể thiết lập theo chính sách này:

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">
    <DisplayName>Custom label used in UI</DisplayName>
    <APIKey ref="variable_containing_api_key"/>
</VerifyAPIKey>

<VerifyAPIKey> thuộc tính

Ví dụ sau đây cho thấy các thuộc tính trên thẻ <VerifyAPIKey>:

<VerifyAPIKey async="false" continueOnError="false" enabled="true" name="Verify-API-Key-1">

Bảng sau đây mô tả những thuộc tính chung cho tất cả phần tử mẹ của chính sách:

<DisplayName> phần tử

Hãy sử dụng cùng với thuộc tính name để gắn nhãn chính sách trong phần trình chỉnh sửa proxy giao diện người dùng quản lý có tên ngôn ngữ tự nhiên khác.

<DisplayName>Policy Display Name</DisplayName>

<APIKey> phần tử

Phần tử này chỉ định biến luồng chứa khoá API. Thông thường, ứng dụng gửi khoá API trong tham số truy vấn, tiêu đề HTTP hoặc tham số biểu mẫu. Ví dụ: nếu khoá được gửi trong tiêu đề có tên là x-apikey, thì bạn sẽ tìm thấy khoá trong biến: request.header.x-apikey

Thuộc tính

Bảng sau đây mô tả các thuộc tính của phần tử <APIKey>

Ví dụ

Trong những ví dụ này, khoá được chuyển vào các tham số và một tiêu đề có tên là x-apikey.

Dưới dạng tham số truy vấn:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.queryparam.x-apikey"/>
</VerifyAPIKey>

Dưới dạng tiêu đề HTTP:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.header.x-apikey"/>
</VerifyAPIKey>

Dưới dạng tham số biểu mẫu HTTP:

<VerifyAPIKey name="APIKeyVerifier">
    <APIKey ref="request.formparam.x-apikey"/>
</VerifyAPIKey>

Giản đồ

Biến luồng

Khi chính sách Xác minh khoá API được thực thi trên một khoá API hợp lệ, Edge sẽ điền sẵn một tập hợp quy trình biến. Các biến này sẽ có sẵn trong các chính sách hoặc mã được thực thi sau trong quy trình và thường được dùng để thực hiện xử lý tuỳ chỉnh dựa trên các thuộc tính của khoá API như tên ứng dụng, sản phẩm API dùng để uỷ quyền khoá hoặc thuộc tính tuỳ chỉnh của khoá API đó.

Chính sách này điền sẵn một số loại biến luồng, bao gồm:

• Giải pháp chung
• Ứng dụng
• Nhà phát triển
• Công ty
• Số liệu phân tích

Mỗi loại biến luồng có một tiền tố khác nhau. Tất cả biến đều là đại lượng vô hướng, ngoại trừ các biến được biểu thị cụ thể dưới dạng mảng.

Biến luồng chung

Bảng sau đây liệt kê các biến quy trình chung được điền theo chính sách Xác minh khoá API. Tất cả các biến này đều có tiền tố:

verifyapikey.{policy_name}

Ví dụ: verifyapikey.{policy_name}.client_id

Các biến có sẵn bao gồm:

Biến luồng ứng dụng

Chính sách này đã điền sẵn các biến luồng sau đây chứa thông tin về ứng dụng. Tất cả các biến này đều có tiền tố:

verifyapikey.{policy_name}.app.

Ví dụ:

verifyapikey.{policy_name}.app.name

Các biến có sẵn bao gồm:

Biến luồng của nhà phát triển

Các biến luồng sau chứa thông tin về nhà phát triển được điền sẵn bằng . Tất cả các biến này đều có tiền tố:

verifyapikey.{policy_name}.developer

Ví dụ:

verifyapikey.{policy_name}.developer.id

Các biến có sẵn bao gồm:

Biến lưu lượng của công ty

Những biến luồng sau đây có chứa thông tin về công ty được điền sẵn bằng . Tất cả các biến này đều có tiền tố:

verifyapikey.{policy_name}.company

Ví dụ:

verifyapikey.{policy_name}.company.name

Các biến có sẵn bao gồm:

Biến Analytics

Các biến sau đây được tự động điền vào Analytics khi áp dụng chính sách Xác minh khoá API được thực thi cho khoá API hợp lệ. Các biến này chỉ được điền sẵn bằng Khoá API Xác minh và chính sách OAuth.

Các biến và giá trị có thể được dùng làm phương diện để xây dựng báo cáo Analytics nhằm thu được thông tin về mô hình tiêu thụ của nhà phát triển và ứng dụng.

• apiproduct.name
• developer.app.name
• client_id
• developer.id

Tham chiếu lỗi

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Fault variables

These variables are set when a runtime error occurs. For more information, see What you need to know about policy errors.

Example error responses

{  
   "fault":{  
      "faultstring":"Invalid ApiKey",
      "detail":{  
         "errorcode":"oauth.v2.InvalidApiKey"
      }
   }
}

{  
   "fault":{  
      "detail":{  
         "errorcode":"keymanagement.service.DeveloperStatusNotActive"
      },
      "faultstring":"Developer Status is not Active"
   }
}

Example fault rule

<FaultRule name="FailedToResolveAPIKey">
    <Step>
        <Name>AM-FailedToResolveAPIKey</Name>
    </Step>
    <Condition>(fault.name Matches "FailedToResolveAPIKey") </Condition>
</FaultRule>

Chủ đề có liên quan