Rendszer információk

A szolgáltató rendszer állapot információit szolgáltató végpont és funkciók gyűjteménye.

A végponton elérhető funkciókhoz használható az MCC API.

API elérhetőség

https://mcc-web.pointer.hu/assets/js/mcc.api.js

Működési feltételek

Fontos! A HC Pointer Kft által fejlesztett illesztő még fejlesztés alatt áll, ezért most és a jövőben is célszerű a hostolt címről meghívni, vagy esetlegesen lementeni!

Az API használja a jquery függvénykönyvtár object modelljét, illetőleg ajax (aszinkron) metódusát. Jelenleg használt biztosan stabil verzió (mcc.api-hoz): "jquery-1.12.3", ettől eltérni természetesen megengedett.

Fontos! A működéshez szükséges egy API kulcs, melyet minden esetben a HC Pointer Kft. állít ki!

Get system info

Korlátozások

A funkció óránként 1000 darab lekérdezésre van korlátozva, API kulcsonként.

A lekérdezés, a végponthoz tartozó adatokat szolgáltat.

Használat

Eredményül a lekérdező felülethez tartozó információk jelennek meg.

https://mcc-web.pointer.hu/MCC/system/info
	{
    "status": {
        "databases": true,
        "connections": 185
    },
    "maintenance": [
        {
            "date": "Every Day",
            "time": "00:00 - 00:10",
            "name": "DB server restart",
            "affected services": "Cikk"
        }
    ],
    "core": {
        "version": "1.2.7",
        "release": "2021.04.23"
    },
    "api": {
        "version": "1.4.11",
        "release": "2020.01.23"
    },
    "docs": "https://mcc-web.pointer.hu/docs/",
    "www": "https://mcc-web.pointer.hu",
    "mail": "info@pointer.hu"
	}

Status

Paraméter Típus Leírás Default
databases Boolean Adatbázis kapcsolat indikátor NOT NULL
connections Integer Egyidejű kapcsolatok NOT NULL

Figyelem! A database paraméter mutatja, hogy a háttérrendszer adatbázis kapcsolatai élnek. Amennyiben false érték jelenik meg, úgy a szolgáltatás egyes funkciói nem elérhetőek és lekérdezésükkor Resource failed válasz érkezik!

Maintenance

Paraméter Típus Leírás Default
date Date Karbantartás dátuma NOT NULL
time String Karbantartás ideje NOT NULL
name String Karbantartás megnevezése NOT NULL
affected services String Érintett szolgáltatások NOT NULL

Figyelem! A maintenance jelzi, a tervezett karbantartásokat. Minden esetben dátummal, időponttal és érintett szolgáltatás megnevezéssel. A tervezett időpontban a jelzett szolgáltatás nem lesz elérhető!

Core

Paraméter Típus Leírás Default
version DateTime MCC aktuális verzió NOT NULL
release DateTime MCC aktuális verzió dátum NOT NULL

Api

Paraméter Típus Leírás Default
version DateTime API aktuális verzió NOT NULL
release DateTime API aktuális verzió dátum NOT NULL

Elérhetőségek

Paraméter Típus Leírás Default
docs String Dokumentáció NOT NULL
www String Weboldal NOT NULL
mail String E-mail NOT NULL

Minta kódok

				curl --location --request GET 'https://mcc-web.pointer.hu/MCC/system/info' \
				--header 'Content-Type: application/json' \
				--header 'x-api-key: API-KEY' \
				--data-raw ''
			
				$curl = curl_init();

				curl_setopt_array($curl, array(
				  CURLOPT_URL => 'https://mcc-web.pointer.hu/MCC/system/info',
				  CURLOPT_RETURNTRANSFER => true,
				  CURLOPT_ENCODING => '',
				  CURLOPT_MAXREDIRS => 10,
				  CURLOPT_TIMEOUT => 0,
				  CURLOPT_FOLLOWLOCATION => true,
				  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
				  CURLOPT_CUSTOMREQUEST => 'GET',
				  CURLOPT_HTTPHEADER => array(
					'Content-Type: application/json',
					'x-api-key: API-KEY'
				  ),
				));

				$response = curl_exec($curl);
				
				curl_close($curl);
			
				$.MCC({
					'apikey':API-KEY,
					'success':function(){},
					'error':function(){}
				}).getSystemInfo();