L'API Reach 360 è organizzata attorno a REST. La nostra API ha URL prevedibili orientati alle risorse, accetta corpi di richiesta con codifica JSON, restituisce risposte con codifica JSON e utilizza codici di risposta HTTP, autenticazione e verbi standard.

• L'API Reach 360 è disponibile all'indirizzo https://api.reach360.com
• L'API EU Reach 360 è disponibile all'indirizzo https://api.reach360.eu

Per gli ultimi aggiornamenti, consulta il Changelog.

Fai clic qui per scoprire come generare chiavi API in Reach 360.

• Autenticazione
• Controllo delle versioni
• Impaginazione
• Errori
• Supporto

Autenticazione

La tua chiave API viene utilizzata per autenticare le richieste e identifica il tuo account Reach 360. Deve essere archiviato in modo sicuro: assicurati che non sia sottoposto al controllo della versione e che sia accessibile solo a chi ne ha bisogno. Trattala come qualsiasi altra password.

Tutte le richieste API devono utilizzare l'autenticazione al portatore: la tua chiave API deve essere fornita come token Bearer nell'Authorizationintestazione. Tutte le richieste API devono essere effettuate tramite HTTPS. Le chiamate effettuate tramite HTTP semplice falliranno. Anche le richieste API senza autenticazione falliranno.

Controllo delle versioni

Quando vengono apportate modifiche alla nostra API che non sono compatibili con le versioni precedenti, rilasceremo una nuova versione dell'API datata. La versione iniziale dell'API di 2023-04-04 verrà utilizzata quando le richieste non includono un'intestazione. API-Version

Quando viene fornita un'intestazione di versione dell'API non valida, riceverai una risposta 400 con il codice di errore. invalid_api_version Le richieste API andate a buon fine includeranno un'intestazione di API-Version risposta, che indica la versione dell'API utilizzata dalla richiesta.

Ogni volta che viene rilasciata una nuova versione dell'API, la richiamiamo esplicitamente nel nostro Changelog, oltre a creare una nuova voce nella pagina delle versioni dell'API.

Richiesta di esempio

curl -i < https://api.reach360.com/users >\\ 
 -H «Autorizzazione: Bearer $API_KEY» -H «Versione API: 2020-07-16" 
 

Impaginazione

Tutti gli endpoint impaginati sono basati su cursori e restituiscono una proprietà. nextUrl In caso contrarionull, nextUrl indica che potrebbero esserci risultati aggiuntivi. È possibile GET inviare una richiesta all'nextUrlURL per ottenere la pagina successiva dei risultati. Un nextUrl of null indica che non ci sono altri risultati. Tutti gli endpoint impaginati supportano un parametro di stringa di limit query che specifica il numero massimo di risultati da restituire in una singola risposta. Tutti gli endpoint che restituiscono un elenco di risultati supportano l'impaginazione.

Nota: il limit valore deve essere compreso tra 1 e 100 (tranne dove diversamente indicato; il valore predefinito è 50 se non specificato).

Endpoint che supportano la paginazione

• GET /courses
• GET /groups
• GET /groups/{groupId}/users
• GET /invitations
• GET /learning-paths
• GET /learning-paths/{learningPathId}
• GET /learning-paths/{learningPathId}/courses
• GET /groups/{groupId}/managers
• GET /users/{userId}/managing-groups
• GET /reports/activity
• GET /reports/courses/{courseId}
• GET /reports/learners/{userId}
• GET /reports/learning-paths/{learningPathId}/courses
• GET /reports/learning-paths/{learningPathId}/learners
• GET /users
• GET /users/{userId}/groups
• GET /groups/{groupId}/reporters
• GET /users/{userId}/reporting-groups
• GET /webhooks

Errori

Una risposta 400 contenente un elenco di errors verrà restituita quando la richiesta non è valida. Alcuni codici di errore comuni includono:

• validation_failed: Il corpo della richiesta presenta un errore di convalida
• invalid_email: La email proprietà non è un indirizzo e-mail formattato correttamente
• missing_api_key: Nella richiesta manca una chiave API
• invalid_api_key: la chiave API fornita non è valida
• invalid_content_type: la richiesta è mancante/ha il tipo di contenuto errato

Esempio di risposta

{
«errors»: [
{
«code»: «invalid_email», 
 «message»: «\\" email\\» deve essere un'email valida»
}]} 
 
 

Assistenza

Siamo lieti che tu possa connettere Reach 360 con gli strumenti che usi di più. L'assistenza può confermare se le chiamate API funzionano come previsto, ma non possiamo aiutarti a scrivere script personalizzati o a eseguire il debug di applicazioni di terze parti.

Se riscontri un problema, faremo del nostro meglio per aiutarti a risolverlo chiedendo:

• La versione più semplice della chiamata che stai effettuando con l'API
• Se il problema può essere replicato all'esterno dell'applicazione
• Intestazioni di richiesta, intestazioni di risposta (inclusa l'intestazione X-Request-Id), corpi di richiesta e corpi di risposta

Contatta il nostro team e facci sapere cosa sta succedendo. Da lì ce ne occuperemo noi!