Panoramica

Le API REST di Askme Desk ti permettono di integrare la gestione delle richieste e dei ticket nella tua piattaforma, automatizzare workflow di service management e monitorare SLA.

URL Base

https://desk.askme.it/Askme/rest

informazioni

L'URL base dipende dall'istanza Askme Desk configurata per la tua organizzazione. Contatta l'amministratore per ottenere l'indirizzo corretto.

Autenticazione

Tutte le richieste API richiedono autenticazione tramite token Bearer OAuth 2.0 ottenuto via Keycloak.

Authorization: Bearer {access_token}

Per i dettagli su come ottenere e rinnovare il token, consulta la sezione Autenticazione OAuth 2.0.

Sezioni Principali

• Autenticazione OAuth 2.0 — Come autenticarti alle API
• Endpoints API — Lista completa degli endpoint disponibili
• Esempi — Esempi pratici di integrazione

Risorse principali

Le API di Askme Desk sono organizzate attorno alle seguenti risorse:

Risorsa	Base path	Descrizione
Richieste	/rest/richieste/	Gestione richieste di I livello (creazione, assegnazione, presa in carico, chiusura)
Ticket	/rest/ticket/	Gestione ticket di II livello (creazione, avanzamento workflow, assegnazione)
Work Order	/rest/workorder/	Gestione ordini di lavoro associati ai ticket
Knowledge Base	/rest/knowledge/	Consultazione e gestione della Knowledge Base
Allegati	/rest/upload/	Upload e download di allegati
Utenti	/rest/utenti/	Gestione contatti e utenti
Agenda	/rest/agenda/	Gestione eventi calendario
Statistiche	/rest/statistics/	Report e statistiche su richieste, ticket e SLA
Autenticazione	/rest/authentication/	Informazioni utente e token

Codici di Stato HTTP

Codice	Descrizione
200	Richiesta completata con successo
400	Richiesta non valida (parametri mancanti o errati)
401	Autenticazione fallita o token non valido
403	Accesso negato (permessi insufficienti)
404	Risorsa non trovata
500	Errore interno del server

Formato delle risposte

Le risposte che restituiscono liste utilizzano il formato DataTable:

{
  "data": [ ... ],
  "message": "",
  "recordsTotal": 150,
  "recordsFiltered": 42
}

Campo	Tipo	Descrizione
data	array	Array di oggetti risultato
message	string	Eventuale messaggio informativo
recordsTotal	integer	Numero totale di record disponibili
recordsFiltered	integer	Numero di record dopo l'applicazione dei filtri

Le risposte di operazioni di scrittura (creazione, modifica, ecc.) restituiscono un oggetto Info con l'esito dell'operazione:

{
  "idRichiesta": 12345,
  "esitoInvioMail": true
}

Formato dei riferimenti (DomainBean)

Molti campi nelle risposte sono oggetti di tipo DomainBean, che rappresentano entità di dominio:

{
  "id": 1,
  "codice": "SRV_IT",
  "nome": "Servizio IT",
  "descrizione": "Supporto informatico"
}

Content Type

Le API accettano e restituiscono dati in formato JSON:

Content-Type: application/json
Accept: application/json

Client HTTP Consigliati

Puoi utilizzare qualsiasi client HTTP per interagire con le API:

• cURL — Perfetto per test rapidi da terminale
• Postman / Insomnia — Per testing e debugging interattivo
• Axios / Fetch — Per JavaScript/Node.js
• Requests — Per Python
• HttpClient — Per Java

Esempio Rapido

Creazione di una richiesta di I livello tramite cURL:

curl -X POST https://desk.askme.it/Askme/rest/richieste/creazione-richiesta \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "idServizio": 1,
    "idAssetRoot": 10,
    "idTipoRichiesta": 5,
    "idUrgenza": 2,
    "oggetto": "Problema di login",
    "descrizione": "Non riesco ad accedere al portale aziendale",
    "codiceCanale": "WEB"
  }'

Supporto

Hai domande sulle API? Contattaci:

• Email: [email protected]

---

Versione API

La versione corrente delle API e 3.47. Le API seguono il path base /rest.