メインコンテンツまでスキップ

画像削除 API

この API を使用すると、以前に PaaSoo プラットフォームにアップロードした画像ファイルを削除できます。この操作は、不要になった画像リソースを積極的にクリーンアップし、冗長な使用量を削減するのに適しています。

1. 呼び出し方法​

呼び出し方法
  • HTTP Method：GET
  • API エンドポイント：https://api.paasoo.com/image/delete
  • リクエストパラメータ：key、secret、および address を URL に連結して渡します。

注意事項：特殊文字を渡す際のエラーを防ぐため、address パラメータは必ず URL エンコードを行ってください。

2. リクエストのサンプル​

以下は、ブラウザまたはコマンドラインで直接 GET リクエストを実行するサンプルです：

https://api.paasoo.com/image/delete?key=API_KEY&secret=API_SECRET&address=ENCODED_IMAGE_URL
説明
  • ENCODED_IMAGE_URL は、元の画像リンクを UTF-8 形式で URL エンコードした結果を指します。
  • エンコード結果をテストする必要がある場合は、オンラインツールを使用してテキスト変換を行うことができます。

3. リクエストパラメータの説明​

パラメータ型必須説明サンプル
keystringはいAPI Key（英数字8桁）。アカウントの一意の識別子として使用します。PaaSoo の管理コンソールで取得できます。Abcdefgh
secretstringはいAPI Secret（英数字8桁）。key と組み合わせて認証に使用します。PaaSoo の管理コンソールで取得できます。Abc123EF
addressstringはい削除する画像のアドレス。URL エンコードを行ってからリクエストパラメータに追加してください。https%3A%2F%2Ffiles.example.com%2Fimages%2Fxxx.jpg

4. レスポンスパラメータの説明​

4.1 レスポンスフィールドの説明​

パラメータ型説明サンプル
statusintegerPaaSoo クラウド通信プラットフォームに送信された際のレスポンスステータスコード。
API ステータスコード一覧：
  • 0 - success：削除成功
  • 2 - Missing parameters：必須パラメータの欠落
  • 3 - Invalid parameters：パラメータ形式のエラー
  • 4 - Invalid credentials：key または secret のエラー
  • 5 - Unauthorized IP：IP 制限
  • 11 - System error：システムエラー
0
status_codestringステータスの説明。Missing parameters

4.2 成功レスポンスのサンプル​

{
    "status": 0,
    "status_code": "success"
}

説明：status = 0 は、画像ファイルが正常に削除されたことを示します。

4.3 失敗レスポンスのサンプル​

{
    "status": 2,
    "status_code": "Missing parameters."
}

説明：status = 2 は、リクエストに必須パラメータが欠落していることを示します。

5. ベストプラクティスと注意事項​

  1. 削除は復元不可：この削除操作を実行すると、削除された画像は復元できなくなります。慎重に呼び出してください。
  2. セキュリティ：不正なリクエストによる悪意のあるリソース削除を防ぐため、HTTPS プロトコルと IP ホワイトリストを組み合わせて保護することをお勧めします。
  3. パラメータの検証：削除リクエストを送信する前に、URL エンコードが正しく行われていること、および key と secret に誤りがないことを確認してください。
  4. 連携して使用：この API を画像アップロード API や MMS 送信 API と組み合わせて使用し、期限切れや不要になった画像をタイムリーにクリーンアップすることをお勧めします。
  5. 自動クリーンアップ：システムの効率を向上させるため、PaaSoo は画像のアップロードから 30 日後にその画像を自動的に削除する場合があります。30 日経過後にこの API を呼び出した場合、画像はすでにシステムによってクリーンアップされており、再度削除できない可能性があります。

6. 付録​

  • ログ記録：削除操作のログを記録しておくことで、後の監査やトラブルシューティングの際の参考にすることができます。
  • 自動化戦略：定期的なクリーンアップのニーズがある場合は、ビジネス側で自動タスクを開発し、この API を呼び出して一括削除を行うことができます。
テクニカルサポート

API 連携の過程で技術的な問題やビジネスに関する疑問が生じた場合は、いつでも当社の開発者サポートチーム（support@paasoo.com）までご連絡ください。誠心誠意、技術的なサポートを提供いたします。