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

Введение

Quip Messenger API предоставляет RESTful интерфейс для взаимодействия с мессенджером. Все запросы должны быть отправлены на базовый URL: https://api.quip.com/v1

API использует стандартную аутентификацию через токены. Все запросы должны содержать заголовок Authorization: Bearer YOUR_TOKEN.

Аутентификация

Для использования API необходимо получить токен доступа. Токен можно получить через процесс OAuth 2.0 или через личный кабинет разработчика.

{
  "username": "user@example.com",
  "password": "password123"
}

{
  "status": "success",
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_in": 3600,
    "user": {
      "id": 1,
      "username": "user@example.com",
      "full_name": "John Doe"
    }
  }
}

Сообщения

API для работы с сообщениями позволяет отправлять, получать и управлять сообщениями.

{
  "receiver_id": 123,
  "message": "Привет!",
  "type": "text"
}

{
  "status": "success",
  "data": {
    "message_id": 456,
    "created_at": "2024-12-15T10:30:00Z"
  }
}

GET /messages?receiver_id=123&limit=50&offset=0

{
  "status": "success",
  "data": {
    "messages": [
      {
        "id": 1,
        "sender_id": 123,
        "receiver_id": 456,
        "message": "Привет!",
        "type": "text",
        "created_at": "2024-12-15T10:30:00Z"
      }
    ],
    "total": 100,
    "limit": 50,
    "offset": 0
  }
}

Чаты

API для работы с чатами позволяет получать список чатов, создавать группы и управлять ими.

GET /chats?folder_id=0

{
  "status": "success",
  "data": [
    {
      "id": 123,
      "user_id": 456,
      "full_name": "John Doe",
      "last_message": "Привет!",
      "last_message_time": "2024-12-15T10:30:00Z",
      "unread_count": 5
    }
  ]
}

{
  "name": "Моя группа",
  "description": "Описание группы",
  "members": [123, 456, 789]
}

Каналы

API для работы с каналами позволяет создавать каналы, подписываться на них и публиковать сообщения.

{
  "name": "Мой канал",
  "description": "Описание канала",
  "is_private": false
}

{
  "channel_id": 123
}

Ошибки

API возвращает стандартные HTTP коды статуса. В случае ошибки, ответ будет содержать объект с описанием ошибки.

{
  "status": "error",
  "message": "Описание ошибки",
  "code": "ERROR_CODE"
}

Коды ошибок

• 400 - Неверный запрос
• 401 - Не авторизован
• 403 - Доступ запрещен
• 404 - Не найдено
• 500 - Внутренняя ошибка сервера

Лимиты

API имеет следующие лимиты:

• 100 запросов в минуту для обычных пользователей
• 1000 запросов в минуту для разработчиков
• Максимальный размер сообщения: 10 MB
• Максимальный размер файла: 100 MB

Версионирование

Текущая версия API: v1. Версия указывается в URL запроса. При выходе новых версий старые версии будут поддерживаться в течение минимум 12 месяцев.