ABillS
Space shortcuts
Child pages
  • Примеры работы
Skip to end of metadata
Go to start of metadata

Как найти URL на котором находится API

{URL БИЛЛИНГА}/api.cgi/

Добавлена возможность просмотра API при помощи Redocly:

  1. Переместите файлы в misc/api/redocly/* в cgi-bin
  2. Включите конфигурацию $conf{API_SWAGGER}

Admin API - {URL БИЛЛИНГА}/redocly-admin.html

User API - {URL БИЛЛИНГА}/redocly-user.html

Примеры авторизации в USER API

Для авторизации пользователя необходима сессия. Для получения сессии необходимо использовать путь /users/login
В ответе получить параметр sid, после чего его нужно использовать как USERSID header в авторизации на серевере

Авторизация пользователя
curl --location --request POST 'https://demo.abills.net.ua:9443/api.cgi/users/login' \
--header 'Content-Type: application/json' \
--data-raw '{
    "login": "ivanov_v",
    "password": "7518252"
}'


Авторизация пользователя JS
const axios = require("axios");

const data = JSON.stringify({
  login: "ivanov_v",
  password: "7518252",
});

const config = {
  method: "post",
  url: "https://demo.abills.net.ua:9443/api.cgi/users/login",
  headers: {
    "Content-Type": "application/json",
  },
  data: data,
};

axios(config)
  .then(response => {
    console.log(JSON.stringify(response.data));
  })
  .catch(e => {
    console.log(e);
  });

Авторизация в ADMIN API

Авторизация администратора выполняется через API_KEY. Ключ нужно передать в заголовке запроса KEY в значении API_KEY.
Для получения API_KEY нужно его задать через веб-интерфейс Настройки > Администраторы, поле API_KEY.


Примеры работы с USER API

Примеры работы с USER API, на основании пути /user/

Получение информации о пользователе Curl
curl --location --request GET 'https://demo.abills.net.ua:9443/api.cgi/user' \
--header 'USERSID: 3v4fci6B6FA1Wysu'


Получение информации о пользователе JS
const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://demo.abills.net.ua:9443/api.cgi/user',
  headers: { 
    'USERSID': '3v4fci6B6FA1Wysu'
  }
};

axios(config)
  .then(response => {
    console.log(JSON.stringify(response.data));
  })
  .catch(e => {
    console.log(e);
  });

Примеры работы с ADMIN API

Примеры работы с ADMIN API, на основании пути /version/


Получение версии Curl
curl --location --request GET 'https://demo.abills.net.ua:9443/api.cgi/version' \
--header 'KEY: testAPI_KEY12'
Получение информации о пользователе JS
const axios = require('axios');

const config = {
  method: 'get',
  url: 'https://demo.abills.net.ua:9443/api.cgi/version',
  headers: { 
    'KEY': 'testAPI_KEY12'
  }
};

axios(config)
.then(response => {
  console.log(JSON.stringify(response.data));
})
.catch(e => {
  console.log(error);
});

Примеры поиска

Вывод по умолчанию



Вывод дополнительных параметров

Вывод дополнительных параметров происходит передачей в query params, необходимого значения - {URL БИЛЛИНГА}/api.cgi/ПУТЬ?параметр1&параметр2

Пример необходимо дополнительно вывести deposit, registration и reductionDate



Строгий поиск

Если необходимо сделать строгий поиск, тогда необходимо передать, какое именно значение необходимо найти - {URL БИЛЛИНГА}/api.cgi/ПУТЬ?параметр1&параметр2&параметр3=значение


Поиск по части значения

Если нужно найти по началу значения - {URL БИЛЛИНГА}/api.cgi/ПУТЬ?параметр1&параметр2&параметр3=значение*

Если нужно найти по концу значения - {URL БИЛЛИНГА}/api.cgi/ПУТЬ?параметр1&параметр2&параметр3=*значение

Если нужно найти в любом месте значения - {URL БИЛЛИНГА}/api.cgi/ПУТЬ?параметр1&параметр2&параметр3=*значение*


Если нужно найти несколько значений - {URL БИЛЛИНГА}/api.cgi/ПУТЬ?параметр1&параметр2&параметр3=значение1,*значение2

  • No labels