API: Get Auth

Descrizione

Questo endpoint permette di aggiornare la scadenza di una chiave API valida per effettuare richieste alle API. Se la chiave API esiste ed è ancora valida, cioè non è ancora scaduta, viene restituito un errore "302.0".

Parametri

  • key (obbligatorio): La chiave API esistente da aggiornare.
  • code (obbligatorio): Il codice associato alla chiave API.

Chiamata API

La chiamata deve essere effettuata tramite POST all'endpoint:

https://www.fattureweb.com/api/

Esempio di Chiamata POST

{
    "action": "auth",
    "key": "esistenteAPIKey",
    "code": "randomCode123"
}

Esempi di Codice



$url = 'https://www.fattureweb.com/api/';
$data = array(
    'action' => 'auth',
    'key' => 'esistenteAPIKey',
    'code' => 'randomCode123'
);
$options = array(
    'http' => array(
        'header'  => "Content-Type: application/json\r\n",
        'method'  => 'POST',
        'content' => json_encode($data),
    ),
);
$context  = stream_context_create($options);
$result = file_get_contents($url, false, $context);
if ($result === FALSE) { /* Handle error */ }

var_dump($result);

                    

import requests

url = 'https://www.fattureweb.com/api/'
data = {
    'action': 'auth',
    'key': 'esistenteAPIKey',
    'code': 'randomCode123'
}

response = requests.post(url, json=data)
print(response.text)
                    

import java.net.HttpURLConnection;
import java.net.URL;
import java.io.OutputStream;

public class Main {
    public static void main(String[] args) {
        try {
            URL url = new URL("https://www.fattureweb.com/api/");
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setRequestMethod("POST");
            conn.setRequestProperty("Content-Type", "application/json; utf-8");
            conn.setDoOutput(true);

            String jsonInputString = "{\"action\": \"auth\", \"key\": \"esistenteAPIKey\", \"code\": \"randomCode123\"}";
            try (OutputStream os = conn.getOutputStream()) {
                byte[] input = jsonInputString.getBytes("utf-8");
                os.write(input, 0, input.length);
            }

            int responseCode = conn.getResponseCode();
            System.out.println("Response Code: " + responseCode);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
                    

Risposta di Successo

Se la chiamata ha successo, riceverai una risposta come la seguente:

{
    "code": "200",
    "result": {
        "key": "newOrUpdatedAPIKey",
        "request_date": 1698765432,
        "expiration_date": 1698765432
    }
}

Descrizione dei campi:

  • code: Il codice HTTP 200, che indica che la richiesta è stata elaborata con successo.
  • result.key: La chiave API aggiornata o rinnovata.
  • result.request_date: Il timestamp Unix del momento in cui la richiesta è stata processata.
  • result.expiration_date: Il timestamp Unix della nuova data di scadenza della chiave API.

Risposta di Errore

Se si verifica un errore, riceverai una risposta come questa:

{
    "code": "302.0",
    "error": "You already have a valid auth_key, please use it until expired..."
}

Descrizione dei campi:

  • code: Il codice dell'errore specifico, in questo caso 302.0, che indica che la chiave API è ancora valida e non necessita di essere aggiornata.
  • error: Il messaggio di errore che descrive la natura del problema.