Обучающие материалы | Nwicode CMS

API-документация

API Nwicode CMS предоставляет вам возможность управлять как вашими пользователями, так и вашими приложениями.

Основное введение

  • API реализован с помощью REST и защищен базовой HTTP-аутентификацией или токеном на предъявителя.

  • Запросы выполняются через HTTP POST, а ответы доставляются в формате JSON.

  • Для каждого запроса вам необходимо опубликовать все ваши данные вместе с вашими учетными данными, ранее созданными из бэк-офиса.

Создайте своего пользователя API

  • Откройте свой бэк-офис, затем зайдите в Управление> Пользователи> API

  • Создайте своего пользователя и выберите доступ API.

  • Для HTTP Basic Auth просто используйте ваше имя пользователя и пароль.

  • Для токена на предъявителя получите сгенерированный токен и отправьте его в API с помощью заголовка ниже

// user this custom header, we do not use the regular Authorization HTTP header due to some restrictions.

Api-Auth-Bearer: Bearer YOURTOKEN

If your token is: 965327d7caa3d748bb70630b8f1ec64b7f0882ec
so your header will be

Api-Auth-Bearer: Bearer 965327d7caa3d748bb70630b8f1ec64b7f0882ec


Основное использование для библиотеки PHP

Инициируйте API с токеном Basic Auth или Bearer

<?php 
// Init with Basic Auth username/password
\Nwicode\Api::init($domain, $username, $password);

// OR

// Init with Bearer token
\Nwicode\Api::initWithBearer($domain, $bearerToken);

Создать нового пользователя

<?php 
$response = \Nwicode\User::create($email, $password, $firstname, $lastname, $role_id);
if($response->isSuccess()) {
    $user_id = $response->getResponse("user_id");
    $token  = $response->getResponse("token");
} else {
    echo $response->getErrorMessage();
}

Создать заявку

   <?php 
$response = \Nwicode\Application::create($name, $user_id);
if($response->isSuccess()) {
    $app_id = $response->getResponse("app_id");
    $app_url  = $response->getResponse("app_url");
} else {
    echo $response->getErrorMessage();
}


Запустите тестирование (на вашем экземпляре разработки)

Basic Auth

./run-test.sh nwicodeurl basic username password

Bearer token

./run-test.sh nwicodeurl bearer token




Вернуться

Есть вопросы — спрашивайте!

Наши специалисты помогут Вам и окажут бесплатную консультацию

Документация

Новости 1 - 20 из 51
Начало | Пред. | 1 2 3 | След. | Конец