API для работы с NeoText

Инструкция по использованию API Neotext

URL: http://neotext.ru/api
Формат запроса: POST

Параметры:
• user - идентификационный ключ, для того, чтобы его получить обращайтесь по почте support@neotext.ru
• action - выполняемое действие;
• project - дополнительный ключ, для разделения заказов по разным проектам/разделам/пользователям и др. (не обязательный параметр).

Формат ответа: json
Ответ:
• success (int) - флаг успешно ли завершилась операция;
• errors (array) - массив с сообщениями об ошибках, в случае если операция завершилась не удачно.

Заметки:
• все цены должны быть указаны в USD.

Описание действий

1. orders
Возвращает все заказы пользователя, которые расположены в разделе project.

Входные данные: отсутствуют

Выходные данные:
• orders (array) - массив с заказами.

Для каждого элемента содержатся следующие данные:
• order_id (int) - уникальный идентификатор заказа;
• name (string) - название заказа;
• price (float) - цена заказа;
• status (int) - статус (0 – не опубликован, 1 – опубликован, 2 – в работе, 3 – на проверке, 4 – на доработке, 5 – выполнен, 6 – удален).

2. create
Создание заказа по заданным параметрам.
Входные данные:
• name (string) - название заказа;
• description (string) - задание для копирайтера;
• keywords (string) - ключевые слова;
• length (int) - количество символов;
• period (int) - срок исполнения (часов);
• category_id (int) - идентификатор рубрики;
• writer_level (int) - идентификатор уровня копирайтера;
• writer (string) - логин копирайтера либо пустое поле если выбор конкретного копирайтера не требуется, в случае если логин указан но копирайтер с таким логином не был найден заказ не будет создан и будет выдана ошибка.
Выходные данные:
0 – если заказ не был создан, иначе целое число – идентификатор заказа.

3. get_order
Информация о заказе.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные:
• id (int) - идентификатор заказа;
• order_id (int) - идентификатор заказа;
• name (string) - название заказа;
• status (int) - статус заказа;
• keywords (string) - ключевые слова;
• description (string) - задание для копирайтера;
• length (int) - требуемое количество символов;
• price (float) - цена;
• category (string) - раздел;
• period (int) - срок исполнения;
• level (int) - уровень копирайтера;
• date (string) - дата публикации;
• refuse_enabled (int) - возможность отказаться от выполнения;
• content_title (string) - заголовок текста;
• content (string) - текст.

4. save_text
Сохранить текст.
Входные данные:
• order_id (int) - идентификатор заказа;
• text (string) - текст.
Выходные данные: отсутствуют (об успешности можно судить по флагу success).

5. publish
Опубликовать заказ. При публикации заказа деньги списываются со счета заказчика. Заказ становится доступным для поиска копирайтами.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные: отсутствуют.

6. reject
Отправить заказ на доработку.
Входные данные:
• order_id (int) - идентификатор заказа;
• text (string) - причина.
Выходные данные: отсутствуют.

7. refuse
Отказаться от копирайера.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные: отсутствуют.

8. drop
Удалить заказ.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные: отсутствуют.

9. unactive

Снять заказ с публикации (для опубликованного заказа, но не взятого копирайтерами). После снятия заказа деньги возвращаются на счет заказчика.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные: отсутствуют.

10. accept
Принять заказ.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные: отсутствуют.

11. get_price
Запрос стоимости заказа.
Входные данные:
• order_id (int) - идентификатор заказа.
Выходные данные:
• price (float) - стоимость