# ApigeeのServiceCalloutポリシーで外部APIを呼び出す方法

## 目次

1. はじめに

2. Apigeeとは？

3. ServiceCalloutポリシーとは？

4. ServiceCalloutポリシーの設定

    1. ポリシーの追加

    2. 外部APIの選定

    3. リクエスト設定

5. 実装手順

    1. 必要なXML構成

    2. コンフィグレーション例

6. エラーハンドリング

7. トラブルシューティング

8. まとめ

## 1. はじめに

ApigeeはGoogle Cloudの一部であり、API管理ソリューションを提供します。その一環として、ServiceCalloutポリシーを使用して外部APIへのリクエストを管理・実施することが可能です。このガイドでは、Apigeeで外部APIを呼び出すための具体的な手順を提供します。

## 2. Apigeeとは？

Apigeeは、APIライフサイクルの管理を簡素化するためのプラットフォームです。それにより、セキュリティ、負荷分散、監視、分析を統合的に提供します。

## 3. ServiceCalloutポリシーとは？

ServiceCalloutポリシーはApigeeにおける、外部サービスへの同期または非同期のHTTPリクエストを構成する手段です。このポリシーを使用することで、バックエンドシステムへのアクセスをスムーズに実現できます。

## 4. ServiceCalloutポリシーの設定

### 4-1. ポリシーの追加

Apigee管理コンソールにログインし、APIプロキシのサイドバーで「Develop」タブを選択します。次に、「+ Add New Policy」をクリックし、ServiceCalloutポリシーを選びます。

### 4-2. 外部APIの選定

呼び出したい外部APIを選択します。APIのエンドポイントと必要な資格情報（APIキーやOAuthトークンなど）を確認してください。

### 4-3. リクエスト設定

リクエストするHTTPメソッド（GET、POSTなど）を選択し、必要に応じてヘッダーやクエリパラメータを設定します。これらはServiceCalloutポリシーの選定時に設定できます。

## 5. 実装手順

### 5-1. 必要なXML構成

ServiceCalloutポリシーは、XML形式で構成を記述します。以下は基本的な構成の例です。

![img](/mosaic-code.jpg)

### 5-2. コンフィグレーション例

以下は、APIキーをヘッダーで追加する例です。

![img](/mosaic-code.jpg)

## 6. エラーハンドリング

ポリシーの実行中にエラーが発生した場合、<Error>タグでハンドリングを設定できます。たとえば、HTTPステータスコードに基づいて別のアクションをトリガーすることが可能です。

## 7. トラブルシューティング

- **正常なレスポンスがない場合**：エンドポイントURLやヘッダーパラメータの誤りがないか確認します。

- **認証エラー**：APIキーやOAuth情報が正しいか再確認します。

- **タイムアウト**：タイムアウト設定やネットワーク接続を検討し、再設定します。

## まとめ

ApigeeのServiceCalloutポリシーを使用することで、簡単に外部APIとやり取りすることができます。適切な設定とエラーハンドリングによって、堅牢で信頼性の高いAPI呼び出しを実現することができるでしょう。信頼できるAPI管理を目指して、ぜひこの方法を試してみてください。

# ApigeeのServiceCalloutポリシーで外部APIを呼び出す方法

## 目次

1. はじめに

2. Apigeeとは？

3. ServiceCalloutポリシーとは？

4. ServiceCalloutポリシーの設定

    1. ポリシーの追加

    2. 外部APIの選定

    3. リクエスト設定

5. 実装手順

    1. 必要なXML構成

    2. コンフィグレーション例

6. エラーハンドリング

7. トラブルシューティング

8. まとめ

## 1. はじめに

ApigeeはGoogle Cloudの一部であり、API管理ソリューションを提供します。その一環として、ServiceCalloutポリシーを使用して外部APIへのリクエストを管理・実施することが可能です。このガイドでは、Apigeeで外部APIを呼び出すための具体的な手順を提供します。

## 2. Apigeeとは？

Apigeeは、APIライフサイクルの管理を簡素化するためのプラットフォームです。それにより、セキュリティ、負荷分散、監視、分析を統合的に提供します。

## 3. ServiceCalloutポリシーとは？

ServiceCalloutポリシーはApigeeにおける、外部サービスへの同期または非同期のHTTPリクエストを構成する手段です。このポリシーを使用することで、バックエンドシステムへのアクセスをスムーズに実現できます。

## 4. ServiceCalloutポリシーの設定

### 4-1. ポリシーの追加

Apigee管理コンソールにログインし、APIプロキシのサイドバーで「Develop」タブを選択します。次に、「+ Add New Policy」をクリックし、ServiceCalloutポリシーを選びます。

### 4-2. 外部APIの選定

呼び出したい外部APIを選択します。APIのエンドポイントと必要な資格情報（APIキーやOAuthトークンなど）を確認してください。

### 4-3. リクエスト設定

リクエストするHTTPメソッド（GET、POSTなど）を選択し、必要に応じてヘッダーやクエリパラメータを設定します。これらはServiceCalloutポリシーの選定時に設定できます。

## 5. 実装手順

### 5-1. 必要なXML構成

ServiceCalloutポリシーは、XML形式で構成を記述します。以下は基本的な構成の例です。

```xml

<ServiceCallout async="false" continueOnError="false" enabled="true" name="SC-1">

    <Request variable="request">

        <Set>

            <Headers>

                <Header name="Content-Type">application/json</Header>

            </Headers>

            <Verb>GET</Verb>

            <Path>/example/api/resource</Path>

        </Set>

    </Request>

    <Response>calloutResponse</Response>

    <HTTPTargetConnection>

        <URL>http://api.example.com</URL>

    </HTTPTargetConnection>

</ServiceCallout>

```

### 5-2. コンフィグレーション例

以下は、APIキーをヘッダーで追加する例です。

```xml

<ServiceCallout name="SC-2">

    <Request variable="request">

        <Set>

            <Headers>

                <Header name="API-Key">your-api-key-here</Header>

            </Headers>

            <Verb>POST</Verb>

            <Path>/data/update</Path>

            <Payload>{ "data": "sample" }</Payload>

        </Set>

    </Request>

    <Response>calloutResponse</Response>

    <HTTPTargetConnection>

        <URL>https://api.example.com</URL>

    </HTTPTargetConnection>

</ServiceCallout>

```

## 6. エラーハンドリング

ポリシーの実行中にエラーが発生した場合、<Error>タグでハンドリングを設定できます。たとえば、HTTPステータスコードに基づいて別のアクションをトリガーすることが可能です。

## 7. トラブルシューティング

- **正常なレスポンスがない場合**：エンドポイントURLやヘッダーパラメータの誤りがないか確認します。

- **認証エラー**：APIキーやOAuth情報が正しいか再確認します。

- **タイムアウト**：タイムアウト設定やネットワーク接続を検討し、再設定します。

## まとめ

ApigeeのServiceCalloutポリシーを使用することで、簡単に外部APIとやり取りすることができます。適切な設定とエラーハンドリングによって、堅牢で信頼性の高いAPI呼び出しを実現することができるでしょう。信頼できるAPI管理を目指して、ぜひこの方法を試してみてください。

ApigeeのServiceCalloutポリシーで外部APIを呼び出す方法

目次

続きを読むには単価診断を受けてください（30秒）