Torna alla lista

Endpoint

GET /api/v1/vev

Autenticazione

Autenticazione: x-api-key

Ogni richiesta deve includere la chiave API nell'header HTTP X-API-Key.

X-API-Key: <api_key>

Se la chiave è assente o non valida l'API risponde con HTTP 401.

Parametri

Parametro Tipo Obbligatorio Descrizione
q string Opzionale Testo da cercare nel lemma o nelle varianti della voce.
q_mode integer Opzionale Modalità di ricerca per 'q'. Valori: 1=contiene, 2=uguale, 3=inizia con, 4=finisce con. Obbligatorio se si usa 'q'.
q_etimo string Opzionale Testo da cercare nella forma dell'etimo.
q_etimo_mode integer Opzionale Modalità di ricerca per 'q_etimo'. Stessi valori di q_mode. Obbligatorio se si usa 'q_etimo'.
q_defin string Opzionale Testo da cercare nel contenuto delle definizioni.
q_attest string Opzionale Testo da cercare nel campo prima attestazione (es. XIV, XV).
q_attest_mode integer Opzionale Modalità di ricerca per 'q_attest'. Stessi valori di q_mode. Obbligatorio se si usa 'q_attest'.
q_nota string Opzionale Testo da cercare nel campo nota della voce.
pos integer Opzionale ID della categoria grammaticale da filtrare.
rinvii string Opzionale Se impostato a 'off', esclude le voci che sono rinvii ad altra voce. Default: include.
derivati string Opzionale Se impostato a 'off', esclude le voci di tipo derivato o composto. Default: include.
limit integer Opzionale Numero massimo di risultati da restituire. Default: 50.
offset integer Opzionale Numero di risultati da saltare. Default: 0.
all integer Opzionale Se impostato a 1, restituisce tutti i risultati senza paginazione.

Note

  • I filtri sono tutti opzionali e combinabili tra loro (AND logic): una voce viene restituita solo se soddisfa TUTTI i criteri specificati.
  • La ricerca con 'q' è estesa anche alle varianti associate alla voce.
  • ⚠️ L'uso di 'all=1' è sconsigliato su dataset di grandi dimensioni.

Esempio richiesta

GET https://lexiper.it/api/v1/vev?q=casa&q_mode=1&limit=20&offset=0
X-API-Key: {api_key_inbound}

Esempio risposta

{
    "totale_risultati": 142,
    "limit": 20,
    "offset": 0,
    "risultati_restituiti": 20,
    "risultati": [
        {
            "id": "1042",
            "lemma": "casa",
            "disambiguatore": null,
            "pos": "s.f.",
            "tipo": 0,
            "stato": 1
        }
    ]
}

Errore 401

HTTP Status: 401

Autenticazione fallita