Collegarsi alla REST API di NowMetrix
Creare una chiave API, inviarla in modo sicuro con ogni richiesta e verificare la connessione con una breve risposta relativa al contesto dell’account, prima di richiedere dati analitici.
1. Creare e proteggere una chiave API
Accedere a NowMetrix, aprire Impostazioni → API e creare una chiave API con un nome descrittivo per l’integrazione, ad esempio Dashboard interna o Google Sheets. È possibile mantenere fino a 10 chiavi attive. Copiare immediatamente una chiave nuova o ruotata: il valore completo viene mostrato una sola volta.
NOWMETRIX_API_KEY=nm_YOUR_KEY
Rinominare una chiave non ne modifica il valore. La rotazione o la revoca di una chiave riguarda esclusivamente quella chiave. Tutte le chiavi usano le autorizzazioni dell’utente NowMetrix associato e condividono il limite di richieste del tracker.
2. Inviare la chiave con ogni richiesta
La REST API è stateless: non esistono una richiesta di autenticazione separata né una sessione persistente. Inviare la chiave API come token Bearer in ogni richiesta HTTPS.
GET https://api.nowmetrix.com/api/me
Authorization: Bearer nm_YOUR_KEY
Accept: application/json
- URL di base:
https://api.nowmetrix.com - Autenticazione:
Authorization: Bearer nm_YOUR_KEY - Test della connessione:
GET /api/menon richiede il parametro tracker. - Timeout: impostare un timeout definito per la connessione e per la risposta in ogni client.
3. Verificare la connessione con cURL
Usare cURL per eseguire rapidamente il controllo della connessione da un terminale.
API_KEY="nm_YOUR_KEY"
curl --fail-with-body --silent --show-error \
--header "Authorization: Bearer ${API_KEY}" \
--header "Accept: application/json" \
"https://api.nowmetrix.com/api/me"
Una richiesta completata correttamente restituisce HTTP 200 e i tracker disponibili per la chiave API:
{
"authenticated": true,
"current_tracker": "TRACKER_ID",
"trackers": [
{
"tracker": "TRACKER_ID",
"host": "example-media.test"
},
{
"tracker": "SECOND_TRACKER_ID",
"host": "example-studio.test"
}
]
}
PHP 8+
Usare l’estensione cURL di PHP e conservare la chiave API in una variabile d’ambiente.
<?php
$apiKey = getenv('NOWMETRIX_API_KEY');
if (!is_string($apiKey) || $apiKey === '') {
throw new RuntimeException('NOWMETRIX_API_KEY is not set.');
}
$curl = curl_init('https://api.nowmetrix.com/api/me');
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . $apiKey,
'Accept: application/json',
],
CURLOPT_TIMEOUT => 10,
]);
$body = curl_exec($curl);
if ($body === false) {
$error = curl_error($curl);
curl_close($curl);
throw new RuntimeException($error);
}
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
if ($status < 200 || $status >= 300) {
throw new RuntimeException("NowMetrix API returned HTTP {$status}: {$body}");
}
$data = json_decode($body, true, 512, JSON_THROW_ON_ERROR);
print_r($data);
JavaScript (Node.js 18+)
Usare l’API fetch integrata lato server. Non esporre la chiave API in JavaScript eseguito nel browser.
const apiKey = process.env.NOWMETRIX_API_KEY;
if (!apiKey) throw new Error('NOWMETRIX_API_KEY is not set.');
async function main() {
const response = await fetch('https://api.nowmetrix.com/api/me', {
headers: {
Authorization: `Bearer ${apiKey}`,
Accept: 'application/json',
},
signal: AbortSignal.timeout(10_000),
});
const body = await response.text();
if (!response.ok) {
throw new Error(`NowMetrix API returned HTTP ${response.status}: ${body}`);
}
console.log(JSON.parse(body));
}
main().catch((error) => {
console.error(error);
process.exitCode = 1;
});
Python 3
Il pacchetto requests offre un client conciso, con gestione esplicita del timeout e dello stato. Installarlo con python -m pip install requests.
import os
import requests
api_key = os.environ["NOWMETRIX_API_KEY"]
response = requests.get(
"https://api.nowmetrix.com/api/me",
headers={
"Authorization": f"Bearer {api_key}",
"Accept": "application/json",
},
timeout=10,
)
response.raise_for_status()
print(response.json())
Java 11+
L’HttpClient standard di Java è sufficiente per la richiesta autenticata.
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
public class NowMetrixExample {
public static void main(String[] args) throws Exception {
String apiKey = System.getenv("NOWMETRIX_API_KEY");
if (apiKey == null || apiKey.isBlank()) {
throw new IllegalStateException("NOWMETRIX_API_KEY is not set.");
}
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10))
.build();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.nowmetrix.com/api/me"))
.timeout(Duration.ofSeconds(10))
.header("Authorization", "Bearer " + apiKey)
.header("Accept", "application/json")
.GET()
.build();
HttpResponse<String> response = client.send(
request, HttpResponse.BodyHandlers.ofString()
);
if (response.statusCode() < 200 || response.statusCode() >= 300) {
throw new IllegalStateException(
"NowMetrix API returned HTTP " + response.statusCode() + ": " + response.body()
);
}
System.out.println(response.body());
}
}
C# (.NET 6+)
Usare HttpClient con un’intestazione di autorizzazione Bearer e un timeout a livello di applicazione.
using System.Net.Http.Headers;
var apiKey = Environment.GetEnvironmentVariable("NOWMETRIX_API_KEY")
?? throw new InvalidOperationException("NOWMETRIX_API_KEY is not set.");
using var client = new HttpClient
{
BaseAddress = new Uri("https://api.nowmetrix.com"),
Timeout = TimeSpan.FromSeconds(10),
};
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", apiKey);
client.DefaultRequestHeaders.Accept.Add(
new MediaTypeWithQualityHeaderValue("application/json")
);
using var response = await client.GetAsync("/api/me");
var body = await response.Content.ReadAsStringAsync();
if (!response.IsSuccessStatusCode)
{
throw new HttpRequestException(
$"NowMetrix API returned HTTP {(int)response.StatusCode}: {body}"
);
}
Console.WriteLine(body);
Go 1.20+
Usare il client standard net/http e decodificare la risposta JSON in una struttura generica o in tipi personalizzati.
package main
import (
"encoding/json"
"fmt"
"net/http"
"os"
"time"
)
func main() {
apiKey := os.Getenv("NOWMETRIX_API_KEY")
if apiKey == "" {
panic("NOWMETRIX_API_KEY is not set")
}
request, err := http.NewRequest(http.MethodGet, "https://api.nowmetrix.com/api/me", nil)
if err != nil {
panic(err)
}
request.Header.Set("Authorization", "Bearer "+apiKey)
request.Header.Set("Accept", "application/json")
client := &http.Client{Timeout: 10 * time.Second}
response, err := client.Do(request)
if err != nil {
panic(err)
}
defer response.Body.Close()
if response.StatusCode < 200 || response.StatusCode >= 300 {
panic("NowMetrix API returned " + response.Status)
}
var data map[string]any
if err := json.NewDecoder(response.Body).Decode(&data); err != nil {
panic(err)
}
fmt.Printf("%#v\n", data)
}
Ruby 3+
La libreria standard di Ruby può eseguire la richiesta senza un pacchetto HTTP aggiuntivo.
require 'json'
require 'net/http'
api_key = ENV.fetch('NOWMETRIX_API_KEY')
uri = URI('https://api.nowmetrix.com/api/me')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = "Bearer #{api_key}"
request['Accept'] = 'application/json'
response = Net::HTTP.start(
uri.hostname,
uri.port,
use_ssl: true,
open_timeout: 10,
read_timeout: 10
) { |http| http.request(request) }
unless response.is_a?(Net::HTTPSuccess)
raise "NowMetrix API returned HTTP #{response.code}: #{response.body}"
end
puts JSON.pretty_generate(JSON.parse(response.body))
Gestire gli errori di autenticazione e trasporto
Controllare lo stato HTTP prima di decodificare un payload di successo. Le risposte di errore usano una struttura JSON stabile con un error.code interpretabile dalle macchine.
401 missing_token: manca l’intestazione Authorization.401 invalid_token: la chiave non è valida, è stata revocata o sostituita.403 site_not_authorized: la chiave non può accedere al tracker richiesto.429 rate_limit_exceeded: attendere l’intervalloRetry-Afterprima di riprovare.503: riprovare in caso di errori temporanei del backend, usando un backoff esponenziale limitato.
{
"error": {
"code": "invalid_token",
"message": "Bearer token is invalid or revoked."
}
}
Usare un endpoint specifico per tracker
Leggere il valore di current_tracker o di trackers[].tracker da /api/me, quindi passare l’ID del tracker come parametro di query site.
GET https://api.nowmetrix.com/v1/realtime?site=TRACKER_ID
Authorization: Bearer nm_YOUR_KEY
Accept: application/json