# PromoPult API — с чего начать работу

С помощью API promopult.ru можно автоматизировать рутинные операции, выгружать статистику в сторонние системы и решать другие задачи.

# [0.1.0] - 2019-09-11

# Добавлено

  • Get user profile
  • Get project(s) (SEO, PPC)
  • Get SEO project keywords
  • Get SEO project positions
  • Get SEO project links
  • Create project SEO/PPC
  • Add method "tools.region_id_by_host"

Использовать API могут все зарегистрированные пользователи Системы. API является бесплатным.

# Ограничения

На вызовы методов API существуют ограничения:

В случае превышения лимита будет отдан http-код ответа 429.

Так же для отдельных методов могут применяться другие ограничения вызовов. Эта информация содержится в описании метода.

# Авторизация

# Как получить токен

Токен для запросов можно получить в профиле пользователя. Токен можно пересоздавать, в этом случае старый токен будет неактивен.

# Использование

Токен передаём в HTTP заголовке X-Auth-Token.

Пример: X-Auth-Token: 1234567890

В случае ошибки авторизации (неправильный токен, неактивный) будет отдан код ответа 401.

# Запросы к API

В качестве формат взаимодействия мы используем JSON.

# Запрос со страницы описания метода через cURL

Пример получения профиля пользователя:

Командная строка:

curl -X GET "https://api.promopult.ru/V0/user"
-H "Accept: application/json"
-H "X-Auth-Token: 1234567890"

Вернёт:

{
"response": {
"id": 10001,
"email": "user@example.com",
"login": "test123",
"first_name": "Александр",
"last_name": "Александров",
"middle_name": "Александрович",
"phone": "+79991234567",
"billing": {
"balance": 0,
"blocked": 0
}
}
}