Primeros pasos con NonaGuard

Todo lo que necesitas para monitorizar la salud de tu instancia de Odoo, desde el primer escaneo hasta la monitorización continua.

1Inicio Rápido

Obtén tu primer Pulse Score en menos de 60 segundos. No requiere instalación.

Sign up — Create an account at nonaguard.com/signup. 7-day free trial included.
Add your instance — Go to Instances → Add Instance. Enter your Odoo URL, database name, and API key (or username/password). Credentials are AES-encrypted at rest.
Run your first scan — Click Scan Now. Within 60 seconds you'll see your Pulse Score (0–100) with a detailed breakdown of deprecated modules, permission risks, and custom code issues.

2Entendiendo tu Pulse Score

El Pulse Score es una métrica de salud 0–100 para tu instancia de Odoo. Mayor es mejor.

Rangos de puntuación y calificaciones

90–100 (A) — Excellent. Minimal risk. Ready for upgrades.
75–89 (B) — Good. Some minor issues to address.
60–74 (C) — Fair. Notable risks. Plan remediation before major upgrades.
40–59 (D) — Poor. Significant deprecated modules or permission gaps.
0–39 (F) — Critical. High risk of upgrade failures or security issues.

The score combines deprecated module count, permission vulnerabilities, custom code risks, and other heuristics. Each finding has a severity and contributes to the overall grade.

3Configurando Monitorización Continua

Mantén tu Pulse Score actualizado automáticamente y recibe alertas cuando las cosas cambien.

Scheduled scans — Enable daily or weekly scans in Instance Settings. NonaGuard runs scans via Celery Beat in the background.
Score drop alerts — Receive email notifications when your Pulse Score drops by 5+ points between scans.
Critical risk notifications — Get instant alerts when new high-severity or critical vulnerabilities are detected.

For the best experience, use the NonaGuard Connector — it sends health pings every 15 minutes with no open ports or manual scans.

4Instalando el Módulo Conector

The NonaGuard Connector is a free native Odoo module that automatically pushes health data every 15 minutes — no manual scans, no open ports, works behind any firewall.

Read the full Connector documentation →

5Insights IA y Gestión de Equipo

AI-generated recommendations, priority actions, and effort estimates are available out of the box on paid plans.

NonaGuard uses server-managed AI providers (with Groq prioritized) so your team can generate insights immediately without API key setup. Available on all paid plans.

6Team Management

Solo+ Invite team members and assign roles (Admin, Member, Viewer). Control who can add instances, run scans, or view sensitive data. Available on Solo, Agency, Partner, and Enterprise plans.

7API Access & Developer Quickstart

Partner / Enterprise Use the REST API to integrate NonaGuard with your CI/CD pipelines, ticketing systems, or internal dashboards.

Step 1 — Get your API key

Go to Dashboard → Settings → REST API
Click Create API Key
Copy the full key (opk_...) — it's shown only once
Use it as X-API-Key header in all requests

Base URL

https://api.nonaguard.com/api/v1

Interactive docs: Swagger UI · ReDoc

curl examples

List instances:

curl -H "X-API-Key: opk_YOUR_KEY" \
  https://api.nonaguard.com/api/v1/instances/

Trigger a scan:

curl -X POST \
  -H "X-API-Key: opk_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"instance_id": "YOUR_INSTANCE_ID"}' \
  https://api.nonaguard.com/api/v1/scans/trigger

Get scan results:

curl -H "X-API-Key: opk_YOUR_KEY" \
  https://api.nonaguard.com/api/v1/scans/SCAN_ID

Download PDF report:

curl -H "X-API-Key: opk_YOUR_KEY" \
  -o report.pdf \
  https://api.nonaguard.com/api/v1/reports/SCAN_ID/pdf

JavaScript / Node.js

const API_KEY = "opk_YOUR_KEY";
const BASE    = "https://api.nonaguard.com/api/v1";
const headers = { "X-API-Key": API_KEY, "Content-Type": "application/json" };

// Trigger a scan
const { scan_id } = await fetch(`${BASE}/scans/trigger`, {
  method: "POST",
  headers,
  body: JSON.stringify({ instance_id: "YOUR_INSTANCE_ID" }),
}).then(r => r.json());

// Poll until complete (simple example)
let scan;
do {
  await new Promise(r => setTimeout(r, 5000));
  scan = await fetch(`${BASE}/scans/${scan_id}`, { headers }).then(r => r.json());
} while (scan.status === "queued" || scan.status === "running");

console.log(`Score: ${scan.pulse_score}/100 (Grade: ${scan.grade})`);
console.log(`Risks: ${scan.risks_count} total`);

Python

import requests, time

API_KEY = "opk_YOUR_KEY"
BASE    = "https://api.nonaguard.com/api/v1"
headers = {"X-API-Key": API_KEY}

# Trigger a scan
resp = requests.post(f"{BASE}/scans/trigger",
    headers=headers,
    json={"instance_id": "YOUR_INSTANCE_ID"})
scan_id = resp.json()["scan_id"]

# Poll until complete
while True:
    scan = requests.get(f"{BASE}/scans/{scan_id}", headers=headers).json()
    if scan["status"] in ("completed", "failed"):
        break
    time.sleep(5)

print(f"Score: {scan['pulse_score']}/100 (Grade: {scan['grade']})")
print(f"Risks: {scan['risks_count']} total")

# Download PDF report
pdf = requests.get(f"{BASE}/reports/{scan_id}/pdf", headers=headers)
with open("report.pdf", "wb") as f:
    f.write(pdf.content)

Error Codes

401 — Invalid or missing API key
402 — Plan quota exceeded or payment required
403 — Insufficient scope (e.g. scan scope required)
404 — Resource not found
409 — A scan is already running on this instance
429 — Rate limited — wait and retry

8FAQ

View the full FAQ on the homepage →