API - opensource-workshop/connect-cms GitHub Wiki

Connect-CMS には、外部サービスを呼び出すことで実現する機能があります。
例えば、PDF の画像変換や、文章の翻訳です。

一番大きく概要を書くと、以下の図になります。

Connect-CMS --> 外部サービス  

WYSIWYG から呼び出す外部サービスの場合、以下の図になります。

Connect-CMS(WYSIWYG) --> Connect-CMS(サーバ・PHP) --> 外部サービス  

上記に外部サービスとのリクエストとレスポンス・インターフェースも記載します。

Connect-CMS(WYSIWYG) --> Connect-CMS(サーバ・PHP) --> リクエスト・インターフェース --> 外部サービス  
Connect-CMS(WYSIWYG) <-- Connect-CMS(サーバ・PHP) <-- レスポンス・インターフェース <-- 外部サービス  

文章の翻訳を例にします。

Connect-CMS(WYSIWYG) --> Connect-CMS(サーバ・PHP) --> リクエスト・インターフェース --> 外部サービス(文章を受け取って翻訳)  
Connect-CMS(WYSIWYG) <-- Connect-CMS(サーバ・PHP) <-- レスポンス・インターフェース <-- 外部サービス(翻訳した文章を返却)  

Connect-CMS(WYSIWYG)、Connect-CMS(サーバ・PHP)までは、Connect-CMS に実装されています。
リクエスト・インターフェースは仕様として定義されており、このWIKI に記載されます。
外部サービスの部分は、Connect-CMS をサービス提供する事業者などが実装する部分というルールになっています。

各外部サービスのインターフェースは、このページの下の階層にある、それぞれの外部サービスページを参照してください。

オンラインマニュアルのAPIページを参照してください。