In questo esempio ipotizziamo di voler esporre un elenco di annunci.

Cominciamo quindi creando una vista di tipo report o in realtà copiando la vista di sistema Lista Annunci. Quindi:

1. Copia la vista Lista Annunci
2. Modifica la vista e assegna il tag name Jobs.List.API
3. Esponi la vista come API

Adesso crea un token con cui poter usare le API:

1. Crea un utente. Questo è l'utente con cui l'API accederà alla piattaforma
2. Assegna i permessi all'utente. Assegnare solo le autorizzazioni per la lettura Annunci
3. Crea un token API per il vostro utente

Puoi anche usare un utente esistente: ovviamente le autorizzazioni saranno quelle dell'utente che hai scelto. Quindi, se scegli un utente Administrator la chiamate API avranno accesso a tutti i dati della piattaforma.

 

 

Rest v2 - Lettura

Adesso puoi costruire la URL per accedere all'API:

• Dalla gestione dell'utente copia la URL del API REST
• Sostituisci i marcatori VIEW_TAGNAME con il tag name Jobs.List.API

Per esempio, se la URL del API REST è

• https://platform.altamirahrm.com/api/v2//REST/VIEW_TAGNAME

allora la URL per invocare il metodo Job.List.API è:

• https://platform.altamirahrm.com/api/v2/REST/Jobs.List.API

Prima di chiamare questa url è necessario ottenere un token JWT come spiegato nell’articolo precedente al punto 1.

Parametro	Nome	Descrizione	Tipo
header	Token (required)	Token generato precedentemente da AltamiraHRM	string

 

Il parametro Token deve essere inviato come header.

Invocando la URL otterrai l'output che sarà strutturato così:

{
 "Jobs.List.API": [
 {
 "Jobs.FullName": "Acme Inc - 0002 - Junior Sales Account",
 "Jobs.State": "/Non ancora pubblicato/",
 "Jobs.DatePublished": "0001-01-01T00:00:00.000Z",
 "Jobs.DateToUnpublish": "0001-01-01T00:00:00.000Z",
 "Jobs.ReceptionType": "/Back office/"
 },
 {
 "Jobs.FullName": "XYZ Inc - 0003 - Senior software developer",
 "Jobs.State": "/Attualmente pubblicato/",
 "Jobs.DatePublished": "2019-08-17T16:53:24.590Z",
 "Jobs.DateToUnpublish": "0001-01-01T00:00:00.000Z",
 "Jobs.ReceptionType": "/Back office/"
 },
 {
 "Jobs.FullName": "XYZ Inc - 0005 - Accounting specialist",
 "Jobs.State": "/Attualmente pubblicato/",
 "Jobs.DatePublished": "2019-04-04T18:14:33.607Z",
 "Jobs.DateToUnpublish": "0001-01-01T00:00:00.000Z",
 "Jobs.ReceptionType": "/Back office/"
 }
 ]
}

La chiamata restituisce quindi l'elenco degli annunci in piattaforma in un array JSON. Ogni elemento dell'array contiene come proprietà i tagname dei campi inclusi nella vista.

 

 

REST v1 - Lettura

Adesso puoi costruire la URL per accedere all'API:

• Dalla gestione dell'utente copia la URL del API REST
• Sostituisci i marcatori YOUR_APIKEY con la chiave API che hai generato e VIEW_TAGNAME con il tag name Jobs.List.API

Per esempio, se la URL del API REST è

• https://platform.altamirahrm.com/api/v1/altamira/REST/VIEW_TAGNAME?ApiKey=YOUR_APIKEY

allora la URL per invocare il metodo Job.List.API è:

• https://platform.altamirahrm.com/api/v1/altamira/REST/Jobs.List.API?ApiKey=0123456789012345

Ovviamente la chiave API è solo un esempio. Per maggiore sicurezza puoi mettere la chiave API nella header HTTP al posto della URL. Il nome della header è ApiKey.

Puoi già invocare la URL e vedere l'output che sarà strutturato così:

{
 "Jobs.List.API": [
 {
 "Jobs.FullName": "Acme Inc - 0002 - Junior Sales Account",
 "Jobs.State": "/Non ancora pubblicato/",
 "Jobs.DatePublished": "0001-01-01T00:00:00.000Z",
 "Jobs.DateToUnpublish": "0001-01-01T00:00:00.000Z",
 "Jobs.ReceptionType": "/Back office/"
 },
 {
 "Jobs.FullName": "XYZ Inc - 0003 - Senior software developer",
 "Jobs.State": "/Attualmente pubblicato/",
 "Jobs.DatePublished": "2019-08-17T16:53:24.590Z",
 "Jobs.DateToUnpublish": "0001-01-01T00:00:00.000Z",
 "Jobs.ReceptionType": "/Back office/"
 },
 {
 "Jobs.FullName": "XYZ Inc - 0005 - Accounting specialist",
 "Jobs.State": "/Attualmente pubblicato/",
 "Jobs.DatePublished": "2019-04-04T18:14:33.607Z",
 "Jobs.DateToUnpublish": "0001-01-01T00:00:00.000Z",
 "Jobs.ReceptionType": "/Back office/"
 }
 ]
}

La chiamata restituisce quindi l'elenco degli annunci in piattaforma in un array JSON. Ogni elemento dell'array contiene come proprietà i tag name dei campi inclusi nella view.