API

KodiCMS предоставляет возможность программными средствами получать и записывать данные через REST API.

Что такое REST API

REST API определяет набор функций, к которым разработчики могут совершать запросы и получать ответы. Взаимодействие происходит по протоколу HTTP. Преимуществом такого подхода является широкое распространение протокола HTTP, поэтому REST API можно использовать практически из любого языка программирования.

REST API предназначено, в основном, для запросов с внешних серверов, но также со временем внутренние запросы частично мигрируют на API.

Как использовать API

Все вызовы методов API — это GET, POST, PUT, DELETE HTTP-запросы к URL http://.../api/... с некоторым набором параметров.

В документации представлен список доступных методов. Например pages.get -> http://.../api/pages.get.

В ответ на запрос вы получаете его результат, который также описан в документации каждой функции.