Введение

Для технического взаимодействия клиентов с платформой CodeBlast создано API хостинга. Протоколом передачи данных является HTTPS. Запрос к API хостинга осуществляться при помощи методов GET или POST, при этом код ответа от HTTP сервера должен быть «200 OK», в противном случае можно считать, что API хостинга временно недоступен или находится в режиме обслуживания. Все передаваемые параметры GET и POST запросов должны кодироваться как x-www-form-urlencoded.

Виды ответов

Параметр response_type позволяет получить ответ в виде XML или JSON представления.

Типы данных

В API представлены следующие типы данных: boolean, number, string, datetime, base64, а также массивы этих типов array:boolean, array:string, ….

Коды ошибок

Каждый ответ содержит код ошибки и её описание. Коды ошибок, которые относятся ко всем функциям, описаны в таблице ниже.

Код ошибки Расшифровка
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Порядок работы

Использование API хостинга сводится к двум потребностям. Первая - сокращение времени разработки собственного сервиса, в котором хостинг играет второстепенную роль. Вторая - создание партнерской панели управления для продажи услуг хостинга. При этом достаточно завести учетную запись на сайте и использовать её для получения кода авторизации (токен). Таким образом Вы получаете доступ ко всем техническим функциям API.

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

Диаграмма 1. Регистрация

digraph g1 { splines = ortho; concentrate = true; bgcolor = "transparent"; node [fontname = "Arial", fontsize = 11, width=1.30, fixedsize=true]; node [style=filled,color=gold,shape=box]; "Клиент" -> "Получение кода\nподтвеждения" [label=< <I>account_name</I>>, fontname = "Arial", fontsize = 9]; "Получение кода\nподтвеждения" -> "Создание\nучётной записи" [label=< <I>confirmation_code</I>>, fontname = "Arial", fontsize = 9]; "Создание\nучётной записи" -> "Заключение\nдоговора" [label=< <I>account_name</I>>, fontname = "Arial", fontsize = 9]; "Заключение\nдоговора" -> "Создание\nанкеты клиента" [label=< <I>account_name</I>>, fontname = "Arial", fontsize = 9]; "Создание\nанкеты клиента" -> "Получение\nтокена" [label=< <I>account_name</I>>, fontname = "Arial", fontsize = 9]; "Клиент" [style=filled,shape=circle,color=dodgerblue4, fontcolor=white, width=0.65]; }

Диаграмма 2. Работа с техническими функциями

digraph g2 { splines = ortho; concentrate = true; bgcolor = "transparent"; node [fontname = "Arial", fontsize = 11, width=1.30, fixedsize=true]; node [style=filled,color=gold,shape=box]; "Клиент" -> "Получение\nтокена" [label=< <I>account_name</I>>, fontname = "Arial", fontsize = 9]; node [style=filled,color=forestgreen,shape=box]; "Получение\nтокена" -> "Создание заказа" [label=< <I>token_data</I>>, fontname = "Arial", fontsize = 9]; "Получение\nтокена" -> "Создание зоны" [label=< <I>token_data</I>>, fontname = "Arial", fontsize = 9]; "Получение\nтокена" -> "Создание\nзаписи" [label=< <I>token_data</I>>, fontname = "Arial", fontsize = 9]; "Получение\nтокена" -> "Перечисление\nid записей" [label=< <I>token_data</I>>, fontname = "Arial", fontsize = 9]; "Клиент" [style=filled,shape=circle,color=dodgerblue4, fontcolor=white, width=0.65]; }

Пример GET запроса:

https://api.codeblast.ru/<модуль>/<функция>?response_type=<xml|json>
                                           &<параметр>=<значение>

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <поле_ответа>данные ...</поле_ответа>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "поле_ответа": "данные ...",
  "error_code": "OK",
  "error_text": "ошибок нет"
}