baserCMSコアが提供する Web APIを有効化するには、/config/.env
の USE_CORE_API
の値を true
に設定します。
また、baserCMSコアが提供する、認証が必要な Web API も有効化したい場合は、/config/.env
の USE_CORE_ADMIN_API
の値を true
に設定する必要があります。
baserCMSのコアが提供する Web API は、認証方式において JWT を利用します。
REST API を利用する を参考にします。
ステータスコードは主に次のものを利用します。
response.status
で取得できます。
戻り値について基本的に次のキーをベースとして都度必要なものを定義します。
response.data
で取得できます。
データーベースの処理における Exception は次のようにコントロールします。
'データベース処理中にエラーが発生しました。' . $e->getMessage()
独自のAPIを開発するには、プレフィックス認証 を利用すると JWT認証と RESTful なルーティングを簡単に実装する事ができます。
管理システムでは内部的にAJAXによるAPIへのアクセスを行っており、USE_CORE_API
に関わらず、例外的にアクセスを許容します。
USE_CORE_API
が false
に設定されているにも関わらず、アクセスが可能となる条件は次のとおりです。
Api
である