Заметки

Expert level

API-ключ должен быть отправлен в виде маркера Bearer в заголовке Authorization запроса. Получить свой API-ключ.

Список

Конечная точка API:

GET

https://rankify.ru/api/v1/reports

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

curl --location --request GET 'https://rankify.ru/api/v1/reports' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

search

опциональное string

Поисковый запрос.

search_by

опциональное string

Искать по. Допустимые значения: url для URL. По умолчанию: url.

project

опциональное string

Название проекта.

result

опциональное string

The report result. Допустимые значения: good для Хорошо, decent для Приемлемо, bad для Плохо.

sort_by

опциональное string

Сортировать по. Допустимые значения: id для Дата создания, generated_at для Дата генерации, url для URL, result для Результат. По умолчанию: id.

sort

опциональное string

Сортировка. Допустимые значения: desc для По убыванию, asc для По возрастанию. По умолчанию: desc.

per_page

опциональное int

Результатов на странице. Допустимые значения: 10, 25, 50, 100. По умолчанию: 25.

Показать

Конечная точка API:

GET

https://rankify.ru/api/v1/reports/{id}

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

curl --location --request GET 'https://rankify.ru/api/v1/reports/{id}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'

Хранение

Конечная точка API:

POST

https://rankify.ru/api/v1/reports

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

curl --location --request POST 'https://rankify.ru/api/v1/reports' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'url={url}'

Параметр

Тип

Описание

url

обязательное string

The webpage's URL.

privacy

опциональное integer

Report page privacy. Допустимые значения: 0 для Публичный, 1 для Приватный, 2 для Пароль. По умолчанию: 1.

password

опциональное string

The password for the report page. Only works with privacy set to 2.

Обновление

Конечная точка API:

PUT PATCH

https://rankify.ru/api/v1/reports/{id}

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

curl --location --request PUT 'https://rankify.ru/api/v1/reports/{id}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}'

Параметр

Тип

Описание

privacy

опциональное integer

Report page privacy. Допустимые значения: 0 для Публичный, 1 для Приватный, 2 для Пароль.

password

опциональное string

The password for the report page. Only works with privacy set to 2.

results

опциональное integer

Update the report results. Допустимые значения: 0 для Нет, 1 для Да. По умолчанию: 0.

Удалить

Конечная точка API:

DELETE

https://rankify.ru/api/v1/reports/{id}

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

curl --location --request DELETE 'https://rankify.ru/api/v1/reports/{id}' \
--header 'Authorization: Bearer {api_key}'

Отчеты