Первый вызов API

Подробнее о формате взаимодействия с API можно прочитать на странице введение в API.
Подробнее о SDK для работы с API можно прочитать на странице SDK Topvisor: PHP.
Подробнее о параметрах выборки можно прочитать на странице основные параметры запросов.

Для примера получим 10 последних операций из лога банка.

Запрос

  • оператор: get;
  • имя сервиса: bank_2;
  • имя метода: history.

HTTP

				POST /v2/json/get/bank_2/history HTTP/1.1

				Host: api.topvisor.com

				Content‑Type: application/json
				User‑Id: %USER_ID%
				Authorization: bearer %USER_API_KEY%

				{"fields":["date","info","sum"],"orders":[{"name":"date","direction":"DESC"}],"limit":"10"}
			

cURL

				curl 
				‑H 'Content‑Type: application/json' 
				‑H 'User‑Id: %USER_ID%' 
				‑H 'Authorization: bearer %USER_API_KEY%' 
				‑d '{"fields":["date","info","sum"],"orders":[{"name":"date","direction":"DESC"}],"limit":"10"}' 
				"https://api.topvisor.com/v2/json/get/bank_2/history"
			

SDK

				<?php

				use Topvisor\TopvisorSDK\V2 as TV;

				// вместо "..." необходимо прописать путь до файла autoload, если вы используете composer
				include(__DIR__.'/../../autoload.php');

				// пропишите путь к SDK Topvisor, если вы не используете composer
				//include_once('topvisor‑sdk/src/V2/Fields.php');
				//include_once('topvisor‑sdk/src/V2/Page.php');
				//include_once('topvisor‑sdk/src/V2/Pen.php');
				//include_once('topvisor‑sdk/src/V2/Session.php');

				// $accessToken равен API key
				$TVSession = new TV\Session(['userId' => $userId, 'accessToken' => $accessToken]);

				$selectorBankHistory = new TV\Pen($TVSession, 'get', 'bank_2', 'history');
				$selectorBankHistory‑>setFields(['date', 'info', 'sum']);
				$selectorBankHistory‑>setOrders([
					TV\Fields::genOrderData('date', 'DESC')
				]);
				$selectorBankHistory‑>setLimit(10);

				$page = $selectorBankHistory‑>exec();

				// catch error
				if(is_null($page‑>getResult())){
					var_dump($page‑>getErrors());
					return;
				}

				// is array of bank history
				var_dump($page‑>getResult());
			

Конструктор

Ответ

				{"result":[{"date":"2022‑05‑15 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.7"},{"date":"2022‑05‑09 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.59"},{"date":"2022‑05‑11 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.1"},{"date":"2022‑05‑05 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.05"},{"date":"2022‑05‑06 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.83"},{"date":"2022‑05‑06 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.75"},{"date":"2022‑05‑13 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0"},{"date":"2022‑05‑13 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.91"},{"date":"2022‑05‑11 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.06"},{"date":"2022‑05‑06 10:52:30","info":"Проверка позиций по проекту #NN","sum":"‑0.55"}],"limitedBy":10,"total":100}