API dokumentacija

Uvod i generiranje API ključa

Kako bi se pristupilo API sučelju pootrebno je registrirati API ključ na adresi https://transparentnost-koprivnicki-ivanec.avoco.dev/api-pristup. Za generiranje API ključa potrebna je ispravna e-mail adresa i IP adresa (ipv4) sa koje će dolaziti zahtjevi.

Nakon što zaprimite API ključ možete krenuti sa spajanjem na API sučelje.

Spajanje na API sučelje

API sučelje nalazi se na adresi https://transparentnost-koprivnicki-ivanec.avoco.dev/api. Svi upiti se vrše POST metodom JSON podataka.

Autentikacija

Generirani API ključ se šalje u headeru zahtjeva u obliku varijable “api_key”.

api_key : _vas_api_kljuc_

Izlazni podaci

API podržava 3 vrste izlaznih podataka: JSON, XML i CSV. Parametar izlaznih podataka šalje se u “output” varijabli. Polja koja se vraćaju u API-u:

Metode

API podržava dvije vrste upita: query i filter

Metoda QUERY

Query metoda omogućuje pretragu po ključnim riječima polja:

Parametri koji se šalju u JSON formatu:

{
	"method" : "query",
	"query" : “plin”,
	“output” : “json”
}

Metoda FILTER

Metoda query omogućuje pretragu/filtriranje (moguće viđe parametara) po sljedećim parametrima:

Parametri koji se šalju u JSON formatu:

Primjer:

{
	"method" : "filter",
    	"filter" : [
     			 {
			    "filter" : "name",
			    "selector" : "LIKE",
			    "query" : "plin"
     			 }
   		 ],
	“output” : “json”
}

{
	"method" : "filter",
    	"filter" : [
     			 {
			    "filter" : "name",
			    "selector" : "LIKE",
			    "query" : "plin"
     			 },
			{
			    "filter" : "amount",
			    "selector" : ">",
			    "query" : "100"	
			}
   		 ],
	“output” : “xml”
}

API limiti

Dnevni dozvoljeni broj upita po API ključu je 10000.

Moguće greške

Primjeri:

PHP(curl)

<?php
    $api_endpoint = "https://transparentnost-koprivnicki-ivanec.avoco.dev/api";
    $api_key 	  = "_vas_api_kljuc_";
	
    $data = [
    		"method"  => "query",
    		"query"   => "plin",
    		"sort_by" => "name",
    		"sort"    => "ASC",
    		"output"  => "json"
    ]; 
 
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $api_endpoint);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [ 
						"api_key: {$api_key}",
						"cache-control: no-cache"
					]);

    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 10);
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode( $data ) );
	
    curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
	
    $result = curl_exec($ch);

    echo "<pre>";
    	print_r( json_decode( $result ) );
    echo "</pre>";
 
    curl_close($ch);
?>
	

JavaScript(FETCH)

{
    var api_endpoint = "https://transparentnost-koprivnicki-ivanec.avoco.dev/api";
    var api_key      = "_vas_api_kljuc_";

    var params = {
        "method" : "query",
        "query"  : "plin"
    };

    fetch( api_endpoint, {
        method: "POST",
        mode: "cors", 
        cache: "no-cache",
        headers: {
            "Content-Type": "application/json",
            "api_key" : api_key
        },
        redirect: "follow", 
        body: JSON.stringify( params ),
    })
    .then( response => response.json() )
    .then( ( response ) => {

        console.log( response );

    });