Come posso iniziare a utilizzare l'API REST in Postman?
Risposta:
L'API REST di DocuWare è più accessibile che mai. Per configurare Postman per l'API REST, consultare la seguente guida.
Guida introduttiva
Download di Postman
Piattaforma consigliata per il test e la creazione di applicazioni che utilizzano API REST.
Raccolta Postman per API REST di DocuWare
Raccolta preconfigurata di chiamate API rilevanti per DocuWare, che può essere importata in Postman e costantemente aggiornata.
Importazione della raccolta Postman
- Decomprimere la cartella Postman Collection scaricata. All'interno dovrebbero essere presenti due file .json.
- Un file è per la raccolta effettiva di chiamate API e l'altro è l'ambiente che contiene alcune variabili necessarie, come l'URL, il nome utente e la password di DocuWare Cloud.
- Aprire Postman e utilizzare l'opzione Importa nella parte superiore dell'editor dell'area di lavoro.
- Trascinare e rilasciare i due file o navigare manualmente verso il percorso di download per importarli entrambi.
- Accettare la richiesta di importare entrambi i file.
Definizione delle variabili d'ambiente
- Aprire la scheda Ambienti sul lato sinistro e selezionare l'ambiente DocuWare appena importato.
- Qui si noteranno un sacco di variabili diverse, ma la maggior parte sono specifiche per il caso d'uso e possono essere lasciate da sole per il momento. Alcune importanti per iniziare sono:
- ServerUrl (che termina in .cloud / .com ecc. - il nome di DocuWare/Platform viene inserito in un'altra variabile).
- Nome utente
- Password
- Salvare le modifiche.
Autenticazione
Esistono diversi modi per autenticarsi utilizzando l'API REST, ma il più semplice è quello di utilizzare il nostro nome utente e la nostra password. La Postman Collection li ha tutti numerati di conseguenza per rendere il processo più semplice:- Aprire la cartella Authentication/OAuth nella raccolta Postman.
- Iniziare con la chiamata 1. Get Responsible Identity Service e premere Send. Assumendo che la variabile ServerUrl sia impostata correttamente, si dovrebbe ricevere una risposta 200:
- Successivamente, fare lo stesso per la chiamata 2. Ottenere la configurazione di Identity Service
- Infine, scegliere il metodo di autenticazione che si desidera utilizzare. In questo esempio, useremo 3.a Request Token w/ Username & Password e dovremmo ricevere il nostro token di accesso nella risposta.
- Ora siete correttamente autenticati e potete iniziare a testare le altre chiamate della Postman Collection!
La maggior parte della documentazione sulle API REST si trova direttamente in Postman, nella scheda Documentazione sul lato destro:
KBA è applicabile sia alle organizzazioni cloud che a quelle on-premise.
Si prega di notare: Questo articolo è una traduzione dall'inglese. Le informazioni contenute in questo articolo si basano sulla versione originale in inglese del/i prodotto/i. Potrebbero esserci piccoli errori, ad esempio nella grammatica utilizzata nella versione tradotta dei nostri articoli. Sebbene non possiamo garantire la completa accuratezza della traduzione, nella maggior parte dei casi la troverete sufficientemente informativa. In caso di dubbi, si prega di fare riferimento alla versione inglese di questo articolo.