Перейти к основному содержанию

Руководство разработчика

Это руководство поможет вам интегрировать наши API-сервисы в ваше приложение.

Асинхронная обработка

Наш API использует асинхронную модель обработки:
  1. Отправьте задачу: пошлите запрос на генерацию и получите ID задачи
  2. Опрашивайте статус: периодически проверяйте статус задачи
  3. Получите результат: заберите результат генерации после завершения задачи

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

import time
import requests

def wait_for_completion(api_key, task_id, max_wait=300):
    """Poll the task until it completes"""
    url = f"https://api.apimart.ai/v1/tasks/{task_id}"
    headers = {"Authorization": f"Bearer {api_key}"}
    start_time = time.time()

    while time.time() - start_time < max_wait:
        data = requests.get(url, headers=headers).json()["data"]
        status = data["status"]

        if status == "completed":
            return data["result"]
        elif status in ("failed", "cancelled"):
            raise Exception(f"Task {status}: {data.get('error')}")

        time.sleep(2)  # wait 2 seconds before polling again

    raise Exception("Task timeout")

Обработка ошибок

Распространённые ошибки

СтатусОписаниеРешение
400Некорректные параметры запросаПроверьте параметры и формат запроса
401Ошибка аутентификацииПроверьте API-ключ
402Недостаточно средствПополните баланс аккаунта
429Превышен лимит запросовУменьшите частоту запросов
500Ошибка сервераПовторите попытку позже

Пример

import requests

response = requests.post(
    "https://api.apimart.ai/v1/images/generations",
    headers={"Authorization": f"Bearer {api_key}"},
    json={"model": "gpt-4o-image", "prompt": "a cute panda"},
)

if response.status_code != 200:
    error = response.json().get("error", {})
    if response.status_code == 401:
        print("Invalid API key")
    elif response.status_code == 402:
        print("Insufficient account balance")
    else:
        print(f"Error: {error.get('message')}")

Лучшие практики

  1. Кэширование: ссылки на сгенерированные изображения/видео действительны 24 часа
  2. Повторы: реализуйте экспоненциальный откат при временных ошибках
  3. Мониторинг: регулярно проверяйте использование API и квоты
  4. Безопасность: храните API-ключ в секрете

Поддержка

Если у вас возникли проблемы в процессе разработки, вы можете получить помощь через:
  • Email: zhihong@apimart.ai
  • Онлайн-чат: посетите наш сайт
  • Документация: ознакомьтесь с полной документацией API