🔗 Uso dell'API

Cosa può fare la lywand API?

Molte aree e funzioni di lywand possono essere gestite automaticamente tramite richieste API. Queste FAQ ti danno una panoramica su come usare l’API, così puoi iniziare subito.

Con la lywand API puoi ad esempio:

• Gestire i clienti: creare clienti, vedere, modificare o cancellare i loro dati

• Gestire obiettivi: aggiungere o rimuovere obiettivi dei tuoi clienti

• Avviare scansioni: avviare scansioni per i tuoi obiettivi e ottenere i risultati

• Recuperare analisi: accesso diretto ad analisi e metriche per tenere d’occhio la sicurezza dei tuoi clienti

Creare una chiave API

Per usare l’API di lywand, ti serve una chiave API che poi puoi collegare ai tuoi servizi. Per creare una nuova chiave, vai nel menu IT-Dienstleister su Impostazioni > API.

Qui puoi aggiungere nuove chiavi API e rimuovere quelle vecchie. Puoi avere più chiavi in uso allo stesso tempo. Inoltre, in alto a destra sulla pagina trovi una panoramica delle richieste API che hai fatto questo mese.

Descrizione API

Con la chiave API che hai creato puoi lavorare sulla URL https://api01.lywand.com. Una descrizione dettagliata OpenAPI è disponibile anche a questo indirizzo.

Esempi di utilizzo

Qui trovi alcuni esempi base che ti aiutano a iniziare a usare la lywand API:

• Panoramica su tutti i clienti (Partner Dashboard)

Ricevi una panoramica dettagliata di tutti i tuoi clienti:

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/partner/dashboard/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

• Crea un nuovo cliente

Aggiungi un nuovo cliente più le sue informazioni:

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/tenants/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "companyName": "string", "companySize": "string", "licenseKey": "string", "website": "string", "sector": "string", "billingAddress": { "country": "string", "postalCode": "string", "city": "string", "street": "string" }, "setupComplete": true, "customerReference": "string", "contractReference": "string", "createDemoAccount": true }'

• Panoramica trasversale di tutte le vulnerabilità e prodotti (dashboard di analisi)

Richiedi le metriche dal dashboard di analisi:

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/partner/analysis/vulnerabilities' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' 

• Richiedi gli obiettivi di un cliente

Dai un'occhiata a tutti gli obiettivi di un cliente:

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/infrastructure/targets/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE' 

• Crea un obiettivo

Crea un nuovo obiettivo esterno per un cliente:

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/infrastructure/targets/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "identifier": "string" }' 

• Elimina obiettivo

Elimina uno o più obiettivi di un cliente:

curl -X 'POST' \
  'http://api01.lywand.com/api/v1/infrastructure/targets/bulk/delete' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{ "identifiers": [ "string" ] }'

• Modifica obiettivo

Modifica le info per uno o più obiettivi di un cliente:

curl -X 'PUT' \
  'http://api01.lywand.com/api/v1/infrastructure/targets/bulk/update' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "targets": [
    {
      "identifier": "string",
      "name": "string",
      "active_directory": {
        "domain": "",
        "distinguished_name": ""
      },
      "display_name": "string",
      "target_type": "string",
      "ips": [
        "string"
      ]
    }
  ]
}'

• Avvia una scansione esterna

Avvia una scansione esterna:

curl -X 'POST' \
  'https://api01.lywand.com/api/v1/scans/' \ 
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'
  -H 'accept: application/json'

Uso dell'API nel contesto di un cliente

Tutte le richieste API vengono eseguite sempre nel contesto dell'account con cui è stata creata la chiave API. Se vuoi accedere ai dati di un cliente o fare azioni per un cliente, devi specificare questo contesto cliente particolare.

Puoi specificare il parametro ?tenant=tenant_id nell’URL. Questo parametro ti permette di eseguire la richiesta per un cliente specifico.

Esempio:

curl -X 'GET' \
  'https://api01.lywand.com/api/v1/results/vulnerabilities/?tenant=tenant_id' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

Attenzione: invece della stringa "tenant_id", devi inserire la vera Tenant ID del tuo cliente.

Traduzione dei contenuti

Vulnerabilità, misure e tanti altri contenuti vengono tradotti automaticamente dall’API. Puoi usare l’header HTTP "Accept-Language" per questo. Al momento sono supportati solo tedesco (de-DE) e inglese (en-GB).

In questo esempio le misure vengono restituite in tedesco:

curl -X GET 'https://api01.lywand.com/api/v1/results/measures/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: de-DE'

Qui in inglese:

curl -X GET 'https://api01.lywand.com/api/v1/results/measures/' \
  -H 'cookie: access_token_cookie=<API-KEY>' \
  -H 'Accept-Language: en-GB'