Conectar con la API REST de NowMetrix
Cree una clave de API, envíela de forma segura con cada solicitud y compruebe la conexión con una respuesta breve que incluya el contexto de la cuenta antes de solicitar datos analíticos.
1. Crear y proteger una clave de API
Inicie sesión en NowMetrix, abra Ajustes → API y cree una clave de API con una etiqueta para la integración, por ejemplo, Panel interno o Google Sheets. Puede mantener hasta 10 claves activas. Copie inmediatamente cada clave nueva o rotada: el valor completo solo se muestra una vez.
NOWMETRIX_API_KEY=nm_YOUR_KEY
Cambiar el nombre de una clave no modifica su valor. Rotar o revocar una clave solo afecta a esa clave. Todas las claves utilizan los permisos de su usuario de NowMetrix y comparten el límite de solicitudes de cada tracker.
2. Enviar la clave con cada solicitud
La API REST no mantiene estado: no existe una solicitud de inicio de sesión independiente ni una sesión persistente. Envíe la clave de API como token Bearer en cada solicitud HTTPS.
GET https://api.nowmetrix.com/api/me
Authorization: Bearer nm_YOUR_KEY
Accept: application/json
- URL base:
https://api.nowmetrix.com - Autenticación:
Authorization: Bearer nm_YOUR_KEY - Prueba de conexión:
GET /api/meno requiere el parámetro del tracker. - Tiempos de espera: establezca un tiempo de espera finito para la conexión y la respuesta en cada cliente.
3. Comprobar la conexión con cURL
Utilice cURL para comprobar rápidamente la conexión desde un terminal.
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 solicitud correcta devuelve HTTP 200 y los trackers disponibles para la clave de 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+
Utilice la extensión cURL de PHP y mantenga la clave de API en una variable de entorno.
<?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+)
Utilice la API fetch integrada en el servidor. No exponga la clave de API en JavaScript del navegador.
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
El paquete requests proporciona un cliente conciso, con un tiempo de espera explícito y comprobación del estado. Instálelo 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+
El HttpClient estándar de Java es suficiente para realizar la solicitud autenticada.
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+)
Utilice HttpClient con una cabecera de autorización Bearer y un tiempo de espera a nivel de aplicación.
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+
Utilice el cliente estándar net/http y descodifique la respuesta JSON en una estructura genérica o en sus propios tipos.
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 biblioteca estándar de Ruby puede realizar la solicitud sin un paquete HTTP adicional.
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))
Gestionar errores de autenticación y transporte
Compruebe el estado HTTP antes de descodificar una respuesta correcta. Las respuestas de error utilizan una estructura JSON estable con un error.code legible por máquinas.
401 missing_token: falta la cabecera Authorization.401 invalid_token: la clave no es válida, se ha revocado o se ha sustituido.403 site_not_authorized: la clave no puede acceder al tracker solicitado.429 rate_limit_exceeded: espere el intervalo deRetry-Afterantes de volver a intentarlo.503: vuelva a intentar los fallos temporales del backend con un retroceso exponencial acotado.
{
"error": {
"code": "invalid_token",
"message": "Bearer token is invalid or revoked."
}
}
Utilizar un endpoint específico de un tracker
Lea el valor de current_tracker o de trackers[].tracker en /api/me y, a continuación, envíe el ID de ese tracker como parámetro de consulta site.
GET https://api.nowmetrix.com/v1/realtime?site=TRACKER_ID
Authorization: Bearer nm_YOUR_KEY
Accept: application/json