概要¶
Guance Open API は、シンプルな HTTP REST API です。
- GET / POST リクエストのみ
- リソース指向の URL を使用して API を呼び出し
- HTTP ステータスコードでリクエストの成功/失敗を通知
- すべてのリクエストは JSON 構造で応答
- Open API は Guance プラットフォームにプログラムからアクセスします
サポートするエンドポイント¶
| デプロイメントタイプ | ノード名 | エンドポイント |
|---|---|---|
| SaaS デプロイメント | 中国リージョン1（杭州） | https://openapi.guance.com |
| SaaS デプロイメント | 中国リージョン2（寧夏） | https://aws-openapi.guance.com |
| SaaS デプロイメント | 中国リージョン4（広州） | https://cn4-openapi.guance.com |
| SaaS デプロイメント | 中国リージョン6（香港） | https://cn6-openapi.guance.one |
| SaaS デプロイメント | 海外リージョン1（オレゴン） | https://us1-openapi.guance.com |
| SaaS デプロイメント | 欧州リージョン1（フランクフルト） | https://eu1-openapi.guance.one |
| SaaS デプロイメント | アジアパシフィックリージョン1（シンガポール） | https://ap1-openapi.guance.one |
| SaaS デプロイメント | アフリカリージョン1（南アフリカ） | https://za1-openapi.guance.com |
| SaaS デプロイメント | インドネシアリージョン1（ジャカルタ） | https://id1-openapi.guance.com |
| SaaS デプロイメント | 中東リージョン1（UAE） | https://me1-openapi.guance.com |
| プライベートデプロイメント | プライベートデプロイメント | 実際にデプロイされたエンドポイントに従います |
共通リクエストヘッダー¶
| パラメーター名 | タイプ | 説明 |
|---|---|---|
| Content-Type | string | application/json |
| DF-API-KEY | string | 呼び出し元の識別子。取得方法はAPI Key 管理を参照してください |
認証方式¶
インターフェースは API KEY を認証方式として使用します。各リクエストは、リクエストボディのヘッダーにある DF-API-KEY の値を有効性の確認と、今回のリクエストのワークスペース限定の基準（この DF-API-KEY が属するワークスペースを取得）として使用します。
現在の Open API で公開されているすべてのインターフェースは、API KEY（ヘッダー：DF-API-KEY）を証明書として提供するだけで済みます。 証明書が存在し有効な場合、認証は成功したと見なされます。
共通レスポンス構造¶
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Number | 返されるステータスコード。HTTP ステータスコードと同じで、エラーがない場合は固定で 200 |
| content | String、Number、Array、Boolean、JSON | 返されるデータ。実際のインターフェースのビジネスに応じて、返されるデータのタイプは異なります |
| pageInfo | JSON | すべてのリストインターフェースの応答におけるリストのページネーション情報 |
| pageInfo.count | Number | 現在のページのデータ件数 |
| pageInfo.pageIndex | Number | ページネーションのページ番号 |
| pageInfo.pageSize | Number | 1ページあたりのサイズ |
| pageInfo.totalCount | Number | 条件に一致する総データ件数 |
| errorCode | String | 返されるエラーステータスコード。空の場合はエラーなし |
| message | String | 返されるエラーコードに対応する具体的な説明情報 |
| success | Boolean | 固定で true。インターフェースの呼び出しが成功したことを示します |
| traceId | Boolean | traceId。リクエストの追跡に使用します |