Техническая документация по новым эндпойнтам API сервиса

Опубликовано: 26.09.2025

Техническая документация API сервиса

Обзор API

Наш сервис предоставляет комплексный API для работы с различными функциями искусственного интеллекта и социальными сетями. Все endpoints работают через HTTPS и возвращают данные в формате JSON.

Базовый URL: https://api-k.ru/api/

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

Для доступа к API требуется аутентификация. Все запросы логируются и обрабатываются с учётом приоритетов.

Эндпоинты API

1. OCR Распознавание текста

Распознает текст из скана паспорта или водительского удостоврения на изображениях с использованием технологии компьютерного зрения.

Endpoint: POST /recognize

Параметры запроса:

{
  "mimeType": "string (обязательный)",
  "languageCodes": ["ru", "en"],
  "model": "page",
  "content": "base64_encoded_image_data"
}

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

curl -X POST https://api-k.ru/api/recognize \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <ваш_api_ключ>" \
  -d '{
    "mimeType": "image/jpeg",
    "languageCodes": ["ru"],
    "model": "page",
    "content": "/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAA..."
  }'

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

{
  "result": {
    "textAnnotation": {
      "fullText": "Пример распознанного текста с изображения",
      "pages": [
        {
          "property": {},
          "width": 800,
          "height": 600,
          "blocks": [
            {
              "boundingBox": {},
              "lines": [
                {
                  "boundingBox": {},
                  "words": [
                    {
                      "boundingBox": {},
                      "text": "Пример",
                      "confidence": 0.98
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

2. Перевод текста

Переводит текст между поддерживаемыми языками.

Endpoint: POST /translate

Параметры запроса:

{
  "targetLanguageCode": "en",
  "texts": ["Текст для перевода", "Второй текст"]
}

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

curl -X POST https://api-k.ru/api/translate \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <ваш_api_ключ>" \
  -d '{
    "targetLanguageCode": "en",
    "texts": ["Привет, как дела?", "Сегодня хорошая погода"]
  }'

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

{
  "translations": [
    {
      "text": "Hello, how are you?",
      "detectedLanguageCode": "ru"
    },
    {
      "text": "The weather is nice today",
      "detectedLanguageCode": "ru"
    }
  ]
}

3. GPT Генерация текста

Генерирует текстовые ответы с помощью продвинутой языковой модели.

Endpoint: POST /completion

Параметры запроса:

{
  "completionOptions": {
    "stream": false,
    "temperature": 0.7,
    "maxTokens": "1000"
  },
  "messages": [
    {
      "role": "user",
      "text": "Ваш запрос к модели"
    }
  ]
}

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

curl -X POST https://api-k.ru/api/completion \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <ваш_api_ключ>" \
  -d '{
    "completionOptions": {
      "temperature": 0.7,
      "maxTokens": "500"
    },
    "messages": [
      {
        "role": "user",
        "text": "Напиши краткое описание преимуществ искусственного интеллекта в бизнесе"
      }
    ]
  }'

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

{
  "result": {
    "alternatives": [
      {
        "message": {
          "role": "assistant",
          "text": "Искусственный интеллект предоставляет бизнесу множество преимуществ...",
          "reasoning": {
            "steps": [
              "Анализ запроса о преимуществах ИИ в бизнесе",
              "Структурирование ответа по ключевым категориям"
            ]
          }
        },
        "status": "ALTERNATIVE_STATUS_FINAL"
      }
    ],
    "usage": {
      "inputTextTokens": "12",
      "completionTokens": "245",
      "totalTokens": "257"
    },
    "modelVersion": "latest"
  }
}

4. Поиск пользователей соц сетей

Ищет пользователей соц сетей по заданным параметрам.

Endpoint: POST /vk/search

Параметры запроса:

{
  "firstName": "Иван",
  "lastName": "Петров",
  "birthDate": "1990-05-15",
  "count": 100,
  "fields": "city,photo,education"
}

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

curl -X POST https://api-k.ru/api/vk/search \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <ваш_api_ключ>" \
  -d '{
    "firstName": "Анна",
    "lastName": "Смирнова",
    "birthDate": "1985-12-20",
    "count": 50
  }'

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

{
  "response": {
    "count": 23,
    "items": [
      {
        "id": 123456789,
        "first_name": "Анна",
        "last_name": "Смирнова",
        "is_closed": false,
        "can_access_closed": true,
        "city": {
          "id": 1,
          "title": "Москва"
        },
        "photo_100": "https://example.com/photo_100.jpg",
        "education": {
          "university": 123,
          "university_name": "МГУ",
          "faculty": 456,
          "faculty_name": "Экономический"
        }
      }
    ]
  }
}

5. Получение информации о пользователе соц сети.

Возвращает подробную информацию о пользователе.

Endpoint: POST /vk/user

Параметры запроса:

{
  "user_id": "123456789",
  "fields": "city,education,career,contacts"
}

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

curl -X POST https://api-k.ru/api/vk/user \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <ваш_api_ключ>" \
  -d '{
    "user_id": "987654321",
    "fields": "city,education,photo_max"
  }'

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

{
  "response": [
    {
      "id": 987654321,
      "first_name": "Сергей",
      "last_name": "Иванов",
      "sex": 2,
      "bdate": "15.8.1988",
      "city": {
        "id": 2,
        "title": "Санкт-Петербург"
      },
      "country": {
        "id": 1,
        "title": "Россия"
      },
      "photo_max": "https://example.com/photo_max.jpg",
      "online": 1,
      "education": {
        "university": 1,
        "university_name": "СПбГУ",
        "graduation": 2010
      },
      "career": [
        {
          "company": "Технологии будущего",
          "position": "Разработчик ПО"
        }
      ]
    }
  ]
}

Коды состояния HTTP

  • 200 OK - запрос выполнен успешно
  • 400 Bad Request - неверные параметры запроса
  • 405 Method Not Allowed - используется неподдерживаемый HTTP метод
  • 500 Internal Server Error - внутренняя ошибка сервера

Ограничения и лимиты

  • OCR распознавание: до 1 запроса в секунду
  • соц сети: до 2 запросов в секунду
  • Размер изображений для OCR: до 3 МБ
  • Длина текста для перевода: до 1 000 символов на запрос
  • Таймаут запросов: 30-60 секунд

Примеры интеграции

JavaScript (Fetch API)

async function translateText(text) {
    const response = await fetch('https://api-k.ru/api/translate', {
        method: 'POST',
        headers: {
            'Content-Type': 'application/json',
            'X-API-Key: <ваш_api_ключ>',
        },
        body: JSON.stringify({
            targetLanguageCode: 'en',
            texts: [text]
        })
    });
    
    return await response.json();
}

Python

import requests

def gpt_completion(prompt, api_key):
    url = "https://api-k.ru/api/completion"
    
    # Заголовки запроса
    headers = {
        'Content-Type': 'application/json',
        'X-API-Key': api_key
    }
    
    data = {
        "completionOptions": {
            "temperature": 0.7,
            "maxTokens": 500  # Исправлено: число вместо строки
        },
        "messages": [
            {
                "role": "user",
                "text": prompt
            }
        ]
    }
    
    try:
        response = requests.post(url, headers=headers, json=data)
        response.raise_for_status()  # Проверка на ошибки HTTP
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"Ошибка запроса: {e}")
        return None

Запрос в формате curl:

curl -X POST "https://api-k.ru/api/completion" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: <ваш_api_ключ>" \
  -d '{
    "completionOptions": {
      "temperature": 0.7,
      "maxTokens": 500
    },
    "messages": [
      {
        "role": "user",
        "text": "Ваш текст запроса здесь"
      }
    ]
  }'

Поддержка

Для технических вопросов и поддержки обращайтесь по адресу: info@antec-it.ru

Последнее обновление документации: 2024 год