AppDrag Support Center

API関数とのやり取り

エンドポイント

Cloud Backend APIは、このシステムに基づいて作成される全機能の道筋を作成します。

- https://あなたの取得ドメイン名.com/api/[フォルダ名]/[ファンクション名]

もしくは
- https://あなたのAppdragのプロジェクト名.appdrag.com/api/ [フォルダ名]/[ファンクション名]




ルートは、提供されているドキュメントと同様に、関数編集ページの左上隅に表示されます。


パラメータ

パラメータは以下の様に渡す必要があります。

  • メソッドがPOSTに設定されている場合のPOSTパラメータ
  • メソッドがPUTに設定されている場合のPUTパラメータ
  • メソッドがPATCHに設定されている場合のPATCHパラメータ
  • メソッドがDELETEに設定されている場合のDELETEパラメータ
  • メソッドがGETに設定されている場合のクエリ文字列パラメータ
場合によっては、API関数をパブリックにしたくない場合があります。その場合、関数のエディションパネルのセキュリティセクションにある「APIKeyを要する(Require APIKey)」チェックボックスをオンにすることができます。この関数に対して行われる全ての呼び出しには、APIKeyパラメータが必要となります。

認証とアクセス制御の詳細については、この記事をご参照下さい。


レスポンス内容と種類

関数の目的は異なる場合がある為、幾つかのタイプのレスポンスをご提供します。
下記例は、返却されたJSONオブジェクトになります。

  • status:関数は正常に実行されたか
  • execTime:関数の実行にかかった時間(ミリ秒)
  • billedTime:計画時間からの差分時間
  • payload:関数のレスポンス内容
  • logs:エラーが発生した場合
レスポンスを受ける為の別の方法として、RAW形式があります。 このメソッドは、関数が返すもののみを生成します。 たとえばHTMLコンテンツのみを返すといった事を探しているのであれば、理想的な形式となります。

その他の記事

お困り事はありますか?

FAQ

まずは、ご質問をされる前に良くある質問を
ご覧ください!

Open FAQ

チャット

AppDragチームと直接チャットしましょう!

Open WebChat