関数APIの概要

関数APIの概要

この機能を利用できるプラン:

概要

Zoho Connectで関数APIを使用すると、他のZohoサービスや外部アプリケーションと連携して自動処理を実行できます。また、関数APIにおいて、きっかけ処理と呼ばれる機能(特定のタイミングであらかじめ指定した処理を実行するための機能)を使用すると、他のアプリケーションとの間でデータをやりとりする際に、データをお互いに処理可能な形式に整えることができます。 

APIとは  

API(アプリケーションプログラミングインターフェイス)は、アプリケーションと別のアプリケーションを連携するための仕組みです。他のアプリケーションからの要求(リクエスト)を受信し、その内容に基づいて、データの作成/表示(取得)/更新/削除などを実行できます。APIを利用することで、アプリケーション同士を自由につなげて、さまざまな処理を実行することができます。 

APIエンドポイントとは  

APIエンドポイントは、他のアプリケーションから要求(リクエスト)を受信するためのURLです。  言い換えれば、APIエンドポイントは2つのアプリケーションの間でデータをやりとりする際の接点として機能します。 

Zoho Connectにおける関数APIの使用 

アプリケーション同士を連携する場合、一方のアプリケーションから送信される要求(リクエスト)の形式は、もう一方のアプリケーションに対応した形式となっている必要があります。たとえば、Zoho Connectと、他のタスク管理アプリを連携して、タスク管理アプリにタスクが追加されたら、Zoho Connectにもタスクを作成するとします。この場合、お互いのアプリケーションに対応する形式で要求(リクエスト)と応答(レスポンス)をやりとりする必要があります。 
 
しかし、一方のアプリケーションの要求(リクエスト)形式や応答(レスポンス)形式は、もう一方のアプリケーションでそのまま処理できる形式であるとは限りません。このような場合に関数APIが役立ちます。関数APIを使用すると、連携対象のアプリケーションから送信された要求(リクエスト)の形式をZoho Connectに合った形に整えることができます。

関数APIのきっかけ処理 

きっかけ処理とは、プログラム処理の中の特定のタイミングにおいて、指定した処理を実行するための機能です。Zoho Connectの関数APIのきっかけ処理は、Zoho Connectに対して外部のアプリケーションからAPIリクエストが送信されたときに実行する処理を設定するためのものです。関数APIのきっかけ処理には、APIのリクエスト方法(メソッド)に応じて、GETリクエストきっかけ処理とPOSTリクエストきっかけ処理の2種類があります。きっかけ処理では、カスタム関数を設定します。カスタム関数の設定には、Deluge(デリュージ)というZohoの独自のスクリプト言語を使用します。これにより、要求(リクエスト)から受信したデータをどのように加工処理するかを指定できます。処理の実行時には、送信されたリクエスト(要求)の方法(GETまたはPOST)に応じて、対応するきっかけ処理が実行されます。 
 
  1. GETリクエストきっかけ処理
GETリクエストきっかけ処理で設定したカスタム関数は、APIエンドポイントでGETリクエストを受信すると、実行されます。 
カスタム関数の実行時には、ネットワークやユーザーに関する情報に加え、ヘッダーやパラメーターの情報を取得し、関数内の処理で参照できます。GETリクエストきっかけ処理で取得可能なデータ(パラメーター)は以下のとおりです。

名前
データの種類
説明
params
map
リクエストで送信されたパラメーターです。
headers
map
リクエストで送信されたヘッダーです。
network
map
リクエストの送信先のネットワーク情報です。
user
map
関数APIの設定者の情報です。
 
  1. POSTリクエストきっかけ処理
POSTリクエストきっかけ処理で設定したカスタム関数は、APIエンドポイントでGETリクエストを受信すると、実行されます。POSTリクエストきっかけ処理で取得可能なデータ(パラメーター)は以下のとおりです。
 
名前
データの種類
説明
params
map
リクエストで送信されたパラメーターです。
headers
map
リクエストで送信されたヘッダーです。
body
テキスト(文字列)
リクエスト本文で送信されたデータ(ペイロード)です。
network
map
リクエストの送信先のネットワーク情報です。
user
map
設定者の情報です。
 
カスタム関数では、処理を実行した際のAPIのレスポンス(応答)を設定できます。設定には、以下のパラメーターを使用します。
 
名前
データの種類
説明
statusCode
HTTPのステータスコード
リクエストのステータスコード
初期値:200 OK
response
テキスト(文字列)
APIのレスポンス(応答)
 
カスタム関数で以上のパラメーターが指定されていない場合は、初期値が適用されます。
 
ご不明な点は、support@zohoconnect.comにお問い合わせください。