Che cos'è OpenAPI

OpenAPI Specification (precedentemente Swagger Specification) è un formato di descrizione API per API REST. Un file OpenAPI consente di descrivere l'intera API, inclusi: Endpoint disponibili e operazioni su ciascun endpoint (GET, POST) e i parametri operativi di Input e output per ciascuna operazione.

Qual è il vantaggio di Altamira Open API?

Con questo strumento l'utente può accedere a tutte le API di Altamira sia fisse che dinamiche anche con i parametri e le intestazioni. Se viene aggiunta una nuova vista alla piattaforma e esposta come API, l'utente può facilmente ottenere la descrizione di quell'API.

Come utilizzare il documento OpenAPI generato da AltamiraHRM?

Prima di tutto è necessario loggarsi con un utente valido alla piattaforma AltamiraHRM. Possiamo poi ottenere la struttura dell'API dal seguente Endpoint:

https://platform.altamiraweb.com/api/v3/REST/OpenApi

Ci sono due modi in cui puoi usare la struttura OpenAPI di AltamiraHRM.

1. Strumento OpenAPI online

• Ottieni la struttura OpenAPI dal precedente endpoint
• Vai a https://editor.swagger.io/
• Incolla la struttura Json sulla parte sinistra e sul lato destro potrai l’interfaccia messa a disposizione dallo strumento.

2. Strumento Swagger Altamira.

L'utente può utilizzare lo strumento Swagger integrato in AltamiraHRM che recupera automaticamente il JSON della struttura OpenAPI e lo converte automaticamente nell'interfaccia di test dell'API Swagger. Utilizzando il seguenti url dopo essersi loggati sulla piattaforma:

https://platform.altamiraweb.com/swagger

• Nell'interfaccia OpenAPI di Swagger puoi trovare tutti gli endpoint con diverse categorie come autenticazione, visualizzazioni comuni, ClockIn, GeoFencing, visualizzazioni, visualizzazioni di rapporti utente
• L'utente può modificare l'URL e i protocolli in base alle proprie esigenze.