API клиент: JS / TS / NodeJS

API клиент предоставляет удобный интерфейс взаимодействия с API Топвизор. При работе в IDE предоставляет подсказки и документацию по всем методам API.

Полная документация API клиента с примерами: https://ui.topvisor.com/?path=/docs/api--docs

OpenAPI схему (swagger) можно найти тут: Topvisor OpenAPI

Настройка API клиента

Для подключение API в своем ПО требуется получить API ключ в личном кабинете и указать его в API клиенте.

Пример подключение Api клиента в код: https://ui.topvisor.com/?path=/story/api-livecode--client

Пример использования

Получить список проектов:

// получить список проектов с id и name
const res = await client.gen('/get/projects_2/projects/', ['id', 'name']).call();
if (!res.errors) {
	console.log('Список моих проектов:');
	res.result.forEach((project) => console.log(project));
}

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

Так вы можете писать скрипты автоматизации и запускать прямо на сайте, без настройки своего сервера.

Не запускайте чужой код в браузере без проверки.