Torna alla lista

Collegamento — lista v1

Restituisce i collegamenti approvati per una risorsa federata. Endpoint pubblico — restituisce solo i collegamenti con stato=2 (Approvata). La risposta normalizza sempre la prospettiva: restituisce le informazioni sulla risorsa collegata (non quella richiesta).

Endpoint

GET /api/v1/collegamento

Autenticazione

Autenticazione: none

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
app string Obbligatorio Identificatore della piattaforma (permalink). Esempio: lexiper, verga.
stringa_id string Obbligatorio Tipo risorsa, come registrato in piattaforme_risorse.stringa_id. Esempio: luogo, fotografia.
id integer Obbligatorio ID della risorsa nella piattaforma.
tipo string Opzionale Filtra per tipo di collegamento (es. localizza, illustra, variante).

Note

  • La ricerca è bidirezionale: la risorsa può essere in posizione A o B nella relazione.
  • La risposta mostra sempre la risorsa collegata (l'altro capo), non la risorsa richiesta.
  • Il campo stringa_id corrisponde a piattaforme_risorse.stringa_id della piattaforma.
  • I campi tipo e nota sono null se non valorizzati.

Esempio richiesta

GET https://lexiper.it/api/v1/collegamento?app=lexiper&stringa_id=luogo&id=42
GET https://lexiper.it/api/v1/collegamento?app=verga&stringa_id=luogo&id=7&tipo=localizza

Esempio risposta

{
    "status": "success",
    "data": [
        {
            "id": 15,
            "app": "verga",
            "stringa_id": "luogo",
            "id_risorsa": 7,
            "tipo": "localizza",
            "rel_tipo": 1,
            "nota": null
        }
    ]
}