Interfaccia (API) per l’importazione di candidature

I candidati possono essere importati in onboard tramite un’interfaccia JSON.

Endpoint API

L’endpoint è raggiungibile tramite il seguente URL:

POST https://<azienda>.onboard.org/exports/v2/applications

Header

• API-KEY: Obbligatorio per l’autorizzazione. Riceverete la chiave API dal nostro team di assistenza su richiesta.
• Content-Type: application/json

Parametri

Tutti i parametri devono essere avvolti in un oggetto chiamato “application”.

Parametri richiesti:

• first_name: Nome
• last_name: Cognome
• email: Indirizzo e-mail

Parametri opzionali:

• gender: Genere. Se questo valore non viene inviato, viene utilizzato il valore predefinito sconosciuto. Valori possibili:
  • unknown: non conosciuto / non impostato
  • male: maschile
  • female: femminile
  • diverse: diverso
• language: Lingua in formato ISO 639-1. Valori possibili:
  • una lingua dell'azienda (ad esempio “de”, “it” o “en”)
• nationality: Nazionalità come codice ISO del paese (ad es. “IT”)
• birthdate: Data di nascita nel formato AAAA-MM-GG
• birthplace: Luogo di nascita
• phone: Numero di telefono
• notes: Testo di candidatura / lettera di presentazione
• job_id: ID dell’annuncio di lavoro. Se non viene fornito un job_id, la candidatura viene considerata come una candidatura non sollecitata.
• campaign_id: ID della campagna da cui è stata ricevuta la domanda.
• cv_public_url: URL del CV. Il file viene scaricato da questo URL e salvato a onboard.
• photo_public_url: URL della foto. Il file viene scaricato da questo URL e salvato a onboard.
• video_public_url: URL del video. Il file viene scaricato da questo URL e salvato a onboard.
• file_1_public_url: URL a file-1. Il file viene scaricato da questo URL e salvato a onboard.
• file_2_public_url: URL al file-2. Il file viene scaricato da questo URL e salvato a onboard.
• file_3_public_url: URL al file-3. Il file viene scaricato da questo URL e salvato a onboard.
• file_4_public_url: URL al file-4. Il file viene scaricato da questo URL e salvato a onboard.
• file_5_public_url: URL al file-5. Il file viene scaricato da questo URL e salvato a onboard.
• send_confirmation_email: Determina se un’e-mail di conferma deve essere inviata da onboard al richiedente quando la domanda è stata ricevuta con successo in onboard. Valore predefinito: false. Valori possibili:
  • true: Verrà inviata un’e-mail di conferma
  • false: L’e-mail di conferma non viene inviata
• accept_archivation: Determina se l’applicazione può essere mantenuta a onboard per un periodo superiore a quello predefinito. Valore predefinito: false. Valori possibili:
  • true: La domanda può essere conservata più a lungo
  • false: La domanda non sarà più conservata
• accept_business_group: Determina se l’applicazione può essere condivisa all’interno del gruppo aziendale. Valore predefinito: false.
  • true: L’applicazione può essere trasmessa ad altre società del gruppo.
  • false: La domanda non viene trasmessa all’interno del gruppo di società

Esempio (tutti i parametri):

"application": {
	"first_name": "Max",
	"last_name": "Mustermann",
	"email": "max.mustermann@gmail.com",
	"gender": "male",
	"language": "IT",
	"nationality": "IT",
	"birthdate": "Fri, 06 Dec 1991",
	"birthplace": "Merano",
	"phone": "+39 123 123 1234",
	"notes": "Con la presente mi candido per la posizione XY.",
	"job_id": "RrB7LYD2",
	"campaign_id": "KRBbJBwN",
	"cv_public_url": "https://some.url/assets/cv",
	"photo_public_url": "https://some.url/assets/photo",
	"video_public_url": "https://some.url/assets/video",
	"file_1_public_url": "https://some.url/assets/file1",
	"file_2_public_url": "https://some.url/assets/file2",
	"file_3_public_url": "https://some.url/assets/file3",
	"file_4_public_url": "https://some.url/assets/file4",
	"file_5_public_url": "https://some.url/assets/file5",
	"send_confirmation_email": "false",
	"accept_archivation": "true",
	"accept_business_group": "true",
}

Risposta

Esempio di successo:

{
  "id": "b9d120fha",
  "email": "max.mustermann@gmail.com",
  "created_at": "2023-08-28 00:00:00 UTC"
}

• id: ID della candidatura creata.
• email: Indirizzo e-mail del richiedente.
• created_at: Data di ricezione della domanda.

Codici di stato:

• 201: La candidatura è stata importata con successo (caso di successo).
• 401: Nessuna autorizzazione (chiave API non valida).
• 409: Esiste già una richiesta non richiesta per questo indirizzo e-mail.
• 422: Parametri errati. Ulteriori informazioni nell’oggetto risposta.
• 500: Errore inatteso.