Download the PHP package nchts/ssduu-api-client without Composer

On this page you can find all versions of the php package nchts/ssduu-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of nchts/ssduu-api-client

Informations about the package ssduu-api-client

API Системы сбора данных с узлов учёта

Общие сведения

Версия протокола: 1.0 Источник данных: http://84.18.104.172/api/v1

Сначала выполняется аутентификация через POST запрос с передачей имени пользователя и пароля. После положительного ответа необходимо использовать возвращённый Токен во всех остальных запросах. Эти запросы должны выполняться через заголовок Bearer методом POST. Все ответы возвращаются в формате JSON. Подробнее об HTTP Bearer авторизации можно прочитать здесь: https://tools.ietf.org/html/rfc6750 Простое описание протокола Bearer заключается во включении в заголовки запроса следующей строки:

Authorization: Bearer {TOKEN}

Например:

Authorization: Bearer mFc9dB5f-4.1JqM

Установка тестового примера

composer create-project nchts/ssduu-api-client

Запуск :

php run.php

Аутентификация через API

Формат POST запроса: /user/login?username={username}&password={password}

Если учётная запись принята, то в качестве вернётся AccessToken, который необходимо использовать во всех остальных запросах.

Пример ответа:

Информация об узлах учёта

Параметры возвращаемого объекта:

Параметр Описание Тип Формат
id Ключ Целое число Int
identifier Идентификатор Строковый Varchar(70)
address Адрес Строковый Varchar(100)
address_full Адрес Строковый Varchar(300)
device_type Тип прибора Строковый Varchar(50)
serial Номер прибора Целое число Bigint
consumer Потребитель Строковый Varchar(150)
commercial Коммерческий Булево Bool
last_archive_day Максимальная дата суточного архива Строковый ДД.ММ.ГГГГ ЧЧ:ММ:СС

Форматы представлены в типах базы данных, в скобках указана длина.

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

Запрос списка всех узлов учёта: /device/list

Часть ответа, который представляет собой массив с объектами:

Получение начала и окончания архива

Может быть необходимо при первоначальной загрузке данных. Формат запроса: /archive/range?id={id}

Пример ответа:

Архивы теплосистемы c холодной водой

Количество запрашиваемых архивов ограничено 200 записями за один запрос.

Параметры возвращаемого объекта:

Параметр Описание Тип Формат
time Время Строковый ДД.ММ.ГГГГ
hours Наработка Точное число Double(10,2)*
v5 Объем в подающем трубопроводе Точное число Double(15,3)*
v6 Объем в обратном трубопроводе Точное число Double(15,3)*
t5 Температура в подающем трубопроводе Точное число Double(10,2)*
t6 Температура в обратном трубопроводе Точное число Double(10,2)*
p5 Давление в подающем трубопроводе Точное число Double(10,2)*
p6 Давление в обратном трубопроводе Точное число Double(10,2)*

Формат* - где число до запятой – общее число знаков, а после запятой – точность дробной части. Например, time = 01.07.2019; hours = 23,59; v5 = 12,371; t5 = 16,32; p5 = 6.32.

Формат запроса:

/archive/read-cold-water?id={id}& start={start}& end={end}

Где:

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

Запрос: /archive/read-cold-water?id=100644&start=01.07.2019&end=23.07.2019

Ответ в формате JSON, массив с объектами:

Дата обновления документации: 29.07.2019

All versions of ssduu-api-client with dependencies

PHP Build Version
Package Version
Requires guzzlehttp/guzzle Version ^6.3
php Version ^7.1.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package nchts/ssduu-api-client contains the following files

Loading the files please wait ....