OpenSTAManager
Sito webFacebookYouTubeUltima release
2.4.36
2.4.36
  • 📣Novità
  • Openstamanager
    • 🚀OpenSTAManager
    • 📙Configurazione
      • 🎯Installazione
      • ▶️Inizializzazione
      • 🆙Aggiornamento
      • ⏸️Backup
    • 📘Interfaccia
      • 📚Moduli e plugin
      • 👾Widget
      • ⚙️Stato dei servizi
      • 🔼Gestione upload
    • 📘Moduli
      • 📅Dashboard
        • ➕Creazione
        • 🖌️Modifica
        • ❗Azioni aggiuntive
      • 👤Anagrafiche
        • ➕Creazione
        • 🖌️Modifica
        • 🦠Tipi di anagrafiche
        • 📞Relazioni
        • 🌏Zone
        • 📭Provenienze clienti
        • 🗃️Settori merceologici
        • ❗Azioni aggiuntive
        • 🔧Plugin
          • 🔨Impianti del cliente
          • 🧑Referenti
          • 📍Sedi
          • 📊Statistiche
          • 📤Ddt del cliente
          • 🤵Dichiarazioni d'intento
          • 🎥Storico attività
          • 🛄Allegati
          • 🧾Contratti del cliente
          • 💰Movimenti contabili
          • 📑Regole pagamenti
          • 🔖Note interne
          • ⁉️Info
        • 📇Import anagrafiche
      • 📧Gestione email
        • 🔄Coda di invio
        • 📬Newsletter
        • 📋Liste
        • 📃Template email
        • ✉️Account email
      • 📖Gestione documentale
        • ➕Creazione
        • 🖌️Modifica
        • 📑Categorie documenti
      • 🚚Attività
        • ➕Creazione
        • 🖌️Modifica
        • ⛽Tipi di attività
        • ⏱️Fasce orarie
        • 🚇Stati di attività
        • 🧑‍🔧Tecnici e tariffe
        • 🔊Voci di servizio
        • ❗Azioni aggiuntive
        • 🔧Plugin
          • 📡Impianti
          • ✅Checklist
      • 💰Vendite
        • 🤝Contratti
          • ❗Azioni aggiuntive
          • 🔧Plugin
            • 🪙Consuntivo
            • 📅Pianificazione attività
            • 🔄Rinnovi
            • 📆Pianificazione fatturazione
        • 🧾Preventivi
          • ❗Azioni aggiuntive
          • 🔧Plugin
            • 🪙Consuntivo
            • 🔍Revisioni
        • 📞Ordini cliente
          • ❗Azioni aggiuntive
          • 🔧Plugin
            • 🪙Consuntivo
        • 📃Fatture di vendita
          • ❗Azioni aggiuntive
          • 🔧Plugin
            • 📃Fatturazione elettronica
            • 🖋️Movimenti contabili
            • 📽️Registrazioni
      • 💵Acquisti
        • 📞Ordini fornitore
          • ❗Azioni aggiuntive
          • 🔧Plugin
        • 📄Fatture di acquisto
          • ❗Azioni aggiuntive
          • 🔧Plugin
      • ⚖️Contabilità
        • 🖨️Stampe contabili
        • 1️⃣Prima nota
        • 📖Piano dei conti
        • ⏳Scadenzario
          • 💳Presentazioni bancarie
      • 📦Magazzino
        • 📺Articoli
          • ❗Azioni aggiuntive
          • 🔧Plugin
            • 💸Movimenti
            • 🏷️Serial
            • 🧺Giacenze
            • 📈Statistiche
            • 📑Listino clienti
            • 🧾Listino fornitori
            • ✂️Piani di sconto/magg.
            • 🪛Varianti articolo
            • ➗Provvigioni
        • 📖Movimenti
        • ✂️Piani di sconto/magg.
        • 🧾Listini
          • 📲Import listini
        • 📤DDT in uscita
          • ❗Azioni aggiuntive
        • 📥DDT in entrata
          • ❗Azioni aggiuntive
        • 🏬Giacenze sedi
        • ◾Attributi combinazioni
        • 🔳Combinazioni
      • 🪝Impianti
        • ➕Creazione
        • 🖌️Modifica
        • 🪜Categorie impianti
        • ❗Azioni aggiuntive
        • 🔧Plugin
          • 🔚Interventi svolti
          • 🔌Componenti
      • 📊Statistiche
      • 🔨Strumenti
        • 💡Campi personalizzati
        • 👀Viste
        • 🗣️Utenti e permessi
        • 🎚️Impostazioni
        • 🗃️Tabelle
          • 📦Tipi di spedizione
          • 🎉Eventi
          • 📜Tipi documento
          • 🏷️Causali movimenti
          • ⏲️Tipi scadenze
          • 📑Stati dei contratti
          • 📑Stati dei preventivi
          • ➖Ritenute previdenziali
          • 💸Casse previdenziali
          • 💰IVA
          • 🖊️Modelli prima nota
          • 🏦Banche
          • 🪙Ritenute acconto
          • 💻Categorie articoli
          • 💶Pagamenti
          • ⚱️Porto
          • 📏Unità di misura
          • 🪞Aspetto beni
          • ❔Causali
          • 👨‍🏭Mansioni referenti
        • 🪢Segmenti
        • 📥Import
        • 🖨️Stampe
        • 🚦Stato dei servizi
        • ☑️Checklists
        • ⏫Backup
        • 🔝Aggiornamenti
  • guide
    • 🔮Come si fa?
      • 👏Autofattura
      • 🏦Banca predefinita anagrafica
      • 📲Calendario su telefono
      • ⏱️Contratti a ore
      • 🧑‍🔧Contratti di manutenzione
      • 🙋‍♂️Dichiarazioni d'Intento
      • 📘Fatturazione Elettronica
        • 🏷️Codice identificativo documento e CIG
        • ⌛Decreto Rilancio 2020
        • 🤔Domande comuni
        • ⛔Errori frequenti
        • 🏫Fattura elettronica verso PA
        • 📩Inviare/ricevere fatture elettroniche
        • 🏫Split payment e reverse charge
      • 📃Fatture non elettroniche
      • 🌈Formattazione celle
      • 💵Gestione acconto
      • 🗳️Gestione magazzini
      • 📲Import articoli
      • 💶Incassi e pagamenti
      • 🔜Incassi e pagamenti anticipati
      • 📄Nota di credito
      • 🧑‍🔧Permessi di visualizzazione degli utenti
      • 👨‍🏫Prezzo di vendita automatico
      • 🏢Quantità di magazzino
      • 💸Registrazione di crediti inesigibili
      • 📝Sconto combinato
      • 🗓️Tasks programmati
      • 🔨Verificare l'installazione di OSM
    • 🪂Strumenti esterni
      • 📸Awesome screenshot
    • 📽️Videoguide
      • 🎥Attività/Fatturazione
      • 🎥Autofattura
      • 🎥Preventivo/Consuntivo
      • 🎥Registrazione movimenti bancari
    • 📘F.A.Q.
  • Moduli premium
    • 📙Installazione
    • 📗Budget
    • 📗Disponibilità tecnici
    • 📗Distinta base
    • 📗E-commerce
    • 📗Email ticketing
    • 📗Import FE
    • 📗Registrazione movimenti bancari
    • 📗Scheda accettazione
    • 📗Vendita al banco
  • Configurazioni
    • 📙API
      • 📙Retrieve
    • 📙Google Maps API key
    • 📙OAuth2
  • per sviluppatori
    • 📘Recupero della password
    • 📒Contribuire
    • 📒Personalizzazione
      • 🕹️Codice
      • 🖥️Framework
      • 💾Assets
    • 📒Strutture
      • 📒Moduli
        • 📒Nucleo
        • 📒Stampe
        • 📒Widget
        • 📒Plugin
Powered by GitBook
On this page
  • 📙 Metodo di accesso
  • Richiesta di accesso
  • 📙 Gestione degli accessi
  • 📙 Messaggi di errore
  • 📙 Modalità di utilizzo

Was this helpful?

  1. Configurazioni

API

Guida alla configurazione API

PreviousVendita al bancoNextRetrieve

Last updated 2 years ago

Was this helpful?

Con application programming interface (in acronimo API, in italiano interfaccia di programmazione di un'applicazione), in informatica, si indica ogni insieme di procedure disponibili al programmatore, di solito raggruppate a formare un set di strumenti specifici per l'espletamento di un determinato compito all'interno di un certo programma.

Il gestionale possiede un sistema di API basilare che permette di ottenere i dati registrati al suo interno attraverso un'interfaccia comune, oltre che di creare e aggiornare le informazioni dei vari record salvati.

Il sistema API del gestionale è attualmente in sviluppo, e pertanto le funzioni disponibili potrebbero essere piuttosto ridotte.

Le informazioni qui descritte sono valida a partire dalla versione 2.4 del gestionale.

📙 Metodo di accesso

L'accesso all'API viene garantito esclusivamente tramite il token personale di accesso dell'utente, individuabile nella sezione dedicata alle informazioni sull'account.

Cliccando sulla sezione evidenziata in rosso, si apre una pagina dedicata alla visualizzazione delle informazioni personali dell'utente e che permette la modifica della password e della foto profilo, oltre che la visualizzazione del token per l'API.

Nella sezione denominata API sono disponibili il token e l'URL per accedere al sistema API del gestionale.

In alternativa, è disponibile la seguente risorsa dedicata per l'accesso direttamente da API.

Richiesta di accesso

PUT http://localhost/openstamanager/api

Si ricordi che, come indicato in Modalità di utilizzo, il contenuto della richiesta deve essere formattato come JSON:

{"resource":"login", "username": "<username>", "password", "<password>"}

Request Body

Name
Type
Description

resource

string

Nome della risorsa: login

username

string

Username dell'utente

password

string

Password dell'utente

📙 Gestione degli accessi

Non è al momento disponibile un sistema di permessi per il sistema API, e pertanto chiunque possegga un token può accedere a tutte le informazioni che l'API rende disponibile.

📙 Messaggi di errore

In base allo stato dell'API e alla richiesta effettuata, è possibile che vengano restituiti dei messaggi di stato che informano l'utilizzatore del risultato della richiesta.

In particolare, sono presenti i seguenti status:

  • 200: OK - La richiesta è andata a buon fine.

  • 400: Errore interno dell'API - La richiesta effettuata risulta invalida per l'API.

  • 401: Non autorizzato - Accesso non autorizzato.

  • 404: Non trovato - La risorsa richiesta non risulta disponibile.

  • 500: Errore del server - Il gestionale non è in grado di completare la richiesta.

  • 503: Servizio non disponibile - L'API del gestionale non è abilitata a causa della versione troppo vecchia di MySQL (>= 5.6.5).

📙 Modalità di utilizzo

Ogni richiesta di comunicazione con l'API deve essere composta di una chiave di accesso e di un'operazione richiesta, e deve essere formattata secondo il formato JSON.

In base al tipo di risorsa che si desidera richiedere, sono disponibili quattro metodi HTTP per la comunicazione:

  • POST, dedicato alle richieste di creazione (Create).

  • PUT, dedicato alle richieste di modifica (Update).

  • DELETE, dedicato alle richieste di eliminazione (Delete).

Maggiori informazioni sulle relative risorse disponibili sono presenti nelle prossime sezioni, oltre che all'interno della tabella zz_api_resources del gestionale.

E' disponibile un sistema di gestione degli accessi basilare per l'amministratore del gestionale, che può abilitare l'accesso degli utenti attraverso il modulo .

GET, dedicato alle richieste di informazioni ().

📙
Utenti e permessi
Retrieve
Wikipedia
Area di informazioni dell'utente
Informazioni sull'utente