Red Hat Summit Red Hat Summitサポートコンソール開発者トライアルの開始お問い合わせ

カスタマーポータル統合ガイド

Red Hat Customer Portal 1

アプリケーションを Red Hat カスタマーポータルと統合するためのガイダンス
リンクのコピー

概要

このドキュメントは、顧客のケースを照会および更新するために、Red Hat カスタマーポータルによって公開されている API の使用に関する情報を提供します。

1. はじめに
リンクのコピー

API を使用して、カスタマーポータル http://access.redhat.com と統合できるようになりました [1].このドキュメントでは、一般的なクライアントとフレームワークの例を含む一般的なユースケースの概要を説明します。公式の API ドキュメントは、カスタマーポータル https://access.redhat.com/management/api/case_management にあり、API エンドポイントとペイロード情報の両方が含まれます。

2. Clients
リンクのコピー

カスタマーポータル API は、本質的にクライアントに依存しません。これは、XML データを送受信するリソース URL のセットとして表されます。一般的なクライアントとプラットフォームには、次のものが含まれますが、これらに限定されません。
Expand
クライアント
プラットフォーム/環境
コメント
cURL [a]
コマンドライン (Linux、UNIX、Mac OS X、Microsoft Windows)
コマンドをテストし、簡単な統合を行うための簡単で透過的な方法
Apache HTTP クライアント [b]
Java
HTTP と通信するための最も一般的な Java ライブラリー。単純な HTTP 以外のセマンティック値はほとんど提供されません。XML の固有のバインディングはありません
RESTeasy クライアント [c]
Java
完全な Java モデルの統合。HTTP や XML について考える必要はありません。下に Apache HTTP クライアントを使用します

3. 一般的な方法
リンクのコピー

わかりやすくするために、このドキュメントにはすべてのユースケースの cURL の例が含まれており、任意で他のフレームワークを使用した例も含まれています。cURL は、RESTful リソースとの対話の性質を最も明確に示しています。詳細については、コマンド man curl を使用して cURL の man ページを参照してください。

4. 認証
リンクのコピー

カスタマーポータルの各リクエストを認証する必要があります。リクエストを認証するには、カスタマーポータルのユーザー名とパスワードに基づいて認証トークンを生成し、後続の各リクエストの Authorization ヘッダーでそのトークンを宣言します。
認証トークンの要求の詳細については、Red Hat API の使用を開始する を参照してください。

5. 例
リンクのコピー

次の例は、cURL を使用して Bearer ヘッダーを介して認証トークンを渡す方法を示しています。

例1 ケースのリスト

ログインしたユーザーのアカウントから 10 件のケースを返す 
$ curl -X POST -H ‘Content-Type: application/json’ -H ‘Authorization: Bearer $token’ --data
	‘{
		"offset" : 1,
		"maxResults": 10
	}’
	https://api.access.redhat.com/support/v1/cases/filter

例2 最終更新日でフィルタリング

$ curl -X POST -H ‘Content-Type: application/json’ -H ‘Authorization: Bearer $token’ --data
	‘{
	“startDate” : “2021-01-01”,
	“endDate”: “2021-12-31”
	}’
	https://api.access.redhat.com/support/v1/cases/filter

例3 ケースコメントのリスト

この例では、ケース 0000000 のケースコメントを一覧表示します。
0000000 を、アクセスできるケースの番号に置き換えます。 
$ curl -H ‘Authorization: Bearer $token’ https://api.access.redhat.com/support/v1/cases/0000000/comments

例4 ケースを作成する

この例では POST 操作が使用されており、デフォルトのグループ、重大度レベル、およびタイプを使用して RHEL 6 製品の下にケースが作成されます。 
$ curl -X POST -H 'Content-Type: application/json -H ‘Authorization: Bearer $token’ --data
	'{
	"product":"Red Hat Enterprise Linux",
	"version":"7.0",
	"summary": "Example Case",
	"description": "Example Case created with cURL”
	}'
	https://api.access.redhat.com/support/v1/cases

例5 ケースを更新する

ここでは、PUT メソッドを使用して、既存のケースのデータを更新します。ほとんどのフィールドはこの方法で更新できます。
Case 000000 の製品は Red Hat Enterprise Linux に変更されています。 
$ curl -X PUT -H 'Content-Type: application/json -H ‘Authorization: Bearer $token’ --data
	'{
	"product": “Red Hat Enterprise Linux”,
	"version":"7.0"
	}'
	https://api.access.redhat.com/support/v1/cases/0000000

例6 管理者の注意を引くためにケースをエスカレーションする

これにより、ケースがエスカレートされ、管理者の注意を引くことができます。 
$ curl -X PUT -H 'Content-Type: application/json -H ‘Authorization: Bearer $token’ --data
	'{
	"requestManagementEscalation": true
	}'
	https://api.access.redhat.com/support/v1/cases/0000000

例7 新しいケースコメントを追加する

この例では、POST メソッドを使用して、ケース 0000000 に新しいコメントを追加します。 
$ curl -X POST -H 'Content-Type: application/json -H ‘Authorization: Bearer $token’ --data
	'{
	“commentBody”: “Test comment!  This can contain lots of information, etc.”
	}'
	https://api.access.redhat.com/support/v1/cases/0000000/comments

例8 ケースに添付ファイルを追加する

添付ファイルは XML ペイロードを持たないため、一意です。この例では、フォームでエンコードされた POST を使用して、test.txt という名前のファイルをケース 0000000 に送信します。API は 1GB までのファイルアップロードをサポートします。 
$ curl -X POST -F 'file=@test.txt' -H ‘Authorization: Bearer $token’ https://api.access.redhat.com/support/v1/cases/0000000/attachments

A. 改訂履歴
リンクのコピー

改訂履歴
改訂 2.0-22022-03-23Navinya Shende
Hydra API で例を更新
改訂 2.0-1.4002013-12-18Rüdiger Landmann
Publican 4.0.0 用にリビルド
改訂 2.0-1Fri Nov 1 2013Zac Dover
新しいサイト用に公開
改訂 0.0-0Tue Sep 24 2013Misty Stanley-Jones
既存のドキュメントを Docbook に変換


Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hatトップに戻る