Token API per REST v3

In Altamira API REST v3 è necessario utilizzare un token JWT per autenticarsi correttamente. JSON Web Token (JWT) è uno standard aperto (RFC 7519) che definisce un modo compatto e autonomo per la trasmissione sicura di informazioni tra le parti con oggetti JSON. Queste informazioni sono verificate e affidabili perché sono firmate digitalmente. I token vengono firmati utilizzando una chiave pubblica/privata. Per maggiori informazioni, clicca qui. Gli utenti possono gestire i token Altamira con le seguenti chiamate.

1. Ottenere un token JWT : per generare un token JWT gli utenti devono utilizzare il seguente endpoint:

URL: https://platform.altamirahrm.com/api/v3/REST/getToken

 

Parametro	Nome	Descrizione	Tipo
header	username obbligatoiro	Nome utente	string
header	loginRequest obbligatoiro	Valore fisso a 1	integer
header	password obbligatoiro	Password dell’utente	string

 

I parametri Username, Password and LoginRequest devono essere mandate come header.

 

Risposta:

{
    "data": [
        {
            "token": "Token-Value",
            "refreshToken": "RefreshToken-Value"
        }
    ],
    "result": [
        {
            "status": "Extracted",
            "statusMessage": "",
            "details": []
        }
    ]
}

 

2. Rinnovare il token JWT : per rinnovare un token JWT scaduto gli utenti possono utilizzare il seguente endpoint:

URL: https://platform.altamirahrm.com/api/v3/REST/refreshToken

 

Parametro	Nome	Descrizione	Tipo
header	refreshtoken obbligatoiro	Refreshtoken generato precedentemente da AltamiraHRM	string
header	token obbligatoiro	Token generato precedentemente da AltamiraHRM	string

 

I parametri refreshtoken  e token  devono essere mandate come header.

 

 

Token API per REST v2

E' come la versione v3 ad eccezione delle seguenti differenze:

1. Ottenere un token JWT

URL: https://platform.altamirahrm.com/api/v2/REST/GetToken

 

Parametro	Nome	Descrizione	Tipo
header	Username obbligatoiro	Nome utente	string
header	LoginRequest obbligatoiro	Valore fisso a 1	integer
header	Password obbligatoiro	Password dell’utente	string

 

Risposta:

{
    "token": "Token-Value",
    "refreshToken": "RefreshToken-Value"
}

 

2. Rinnovare il token JWT

URL: https://platform.altamirahrm.com/api/v2/REST/RefreshToken

 

Parametro	Nome	Descrizione	Tipo
header	refreshtoken obbligatoiro	Refreshtoken generato precedentemente da AltamiraHRM	string
header	token obbligatoiro	Token generato precedentemente da AltamiraHRM	string

 

Risposta:

{
    "token": "Token-Value",
    "refreshToken": "RefreshToken-Value"
}

 

 

Come creare un token API per SOAP e REST v1

I token permettono di accedere ai metodi dell'API. I token vengono associati agli utenti in modo che l'accesso alla piattaforma tramite l'API avvenga con le autorizzazioni di sicurezza di quell'utente. Questo significa, per esempio, che se l'utente ha accesso solo agli annunci non potrà utilizzare i metodi collegati ai CV.

Per creare un token API:

1. Entra in Impostazioni  > Sicurezza > Utenti
2. Clicca sul nome dell'utente per cui desideri creare il token API
3. Nella sezione API della scheda clicca su Nuova Chiave

Se l'utente aveva già una chiave API potrai sostituirla cliccando su Nuova Chiave. In questa caso le applicazioni che usano la vecchia chiave non funzioneranno più. Puoi anche eliminare una chiave API cliccando su Elimina Chiave.

Nella sezione API ci sono i seguenti campi:

• Chiave API: è la chiave che deve essere usata nelle applicazioni per acedere all'API. Ogni operazione sui dati della piattaforma verrà effettuate con i diritti e i permessi dell'utente di questa chiave API
• URL della definizione del API SOAP (WSDL): la URL a cui è possibile accedere al WSDL per la definizione del servizio in modalità SOAP. Restituisce tutte le definizioni dei web service, delle operazioni e dei parametri disponibili
• URL del API SOAP: la URL a cui è possibile accedere alla API SOAP
• URL del API REST: la URL a cui è possibile accedere alla API REST