Public Create Employee
curl --request POST \
--url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"gov_id": "<string>",
"is_disabled": true,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": true,
"send_email": false,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/employee/"
payload = {
"name": "<string>",
"gov_id": "<string>",
"is_disabled": True,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": True,
"send_email": False,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
gov_id: '<string>',
is_disabled: true,
admission_date: '2023-12-25',
organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
branch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sector_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
address: '<string>',
address_number: '<string>',
address_detail: '<string>',
zip_code: '<string>',
neighborhood: '<string>',
state: '<string>',
city: '<string>',
social_name: '<string>',
birth_date: '2023-12-25',
mother_name: '<string>',
place_of_birth: '<string>',
phone: '<string>',
cell_phone: '<string>',
email: '<string>',
personal_email: '<string>',
hr_code: '<string>',
e_social: '<string>',
employee_registration_number: '<string>',
e_social_category: '<string>',
work_shift: '<string>',
client_integration_code: '<string>',
create_exam: true,
send_email: false,
send_date: '2023-11-07T05:31:56Z',
disability_analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://public-api.salu.com.vc/dev/routes/v0/employee/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.salu.com.vc/dev/routes/v0/employee/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'gov_id' => '<string>',
'is_disabled' => true,
'admission_date' => '2023-12-25',
'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'branch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sector_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'address' => '<string>',
'address_number' => '<string>',
'address_detail' => '<string>',
'zip_code' => '<string>',
'neighborhood' => '<string>',
'state' => '<string>',
'city' => '<string>',
'social_name' => '<string>',
'birth_date' => '2023-12-25',
'mother_name' => '<string>',
'place_of_birth' => '<string>',
'phone' => '<string>',
'cell_phone' => '<string>',
'email' => '<string>',
'personal_email' => '<string>',
'hr_code' => '<string>',
'e_social' => '<string>',
'employee_registration_number' => '<string>',
'e_social_category' => '<string>',
'work_shift' => '<string>',
'client_integration_code' => '<string>',
'create_exam' => true,
'send_email' => false,
'send_date' => '2023-11-07T05:31:56Z',
'disability_analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.salu.com.vc/dev/routes/v0/employee/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.salu.com.vc/dev/routes/v0/employee/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/employee/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_disabled": true,
"status": "<string>",
"sex": "<string>",
"admission_date": "2023-12-25",
"is_active": true,
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"branch": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"position": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sector": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"social_name": "<string>",
"gov_id": "<string>",
"birth_date": "2023-12-25",
"gender": "<string>",
"mother_name": "<string>",
"marital_status": "<string>",
"place_of_birth": "<string>",
"educational_stage": "<string>",
"human_skin_tone": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"dismissal_date": "2023-12-25",
"hr_code": "<string>",
"employee_registration_number": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"address": {
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Employees
Create Employee
POST
/
v0
/
employee
/
Public Create Employee
curl --request POST \
--url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"gov_id": "<string>",
"is_disabled": true,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": true,
"send_email": false,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/employee/"
payload = {
"name": "<string>",
"gov_id": "<string>",
"is_disabled": True,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": True,
"send_email": False,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
gov_id: '<string>',
is_disabled: true,
admission_date: '2023-12-25',
organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
branch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sector_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
address: '<string>',
address_number: '<string>',
address_detail: '<string>',
zip_code: '<string>',
neighborhood: '<string>',
state: '<string>',
city: '<string>',
social_name: '<string>',
birth_date: '2023-12-25',
mother_name: '<string>',
place_of_birth: '<string>',
phone: '<string>',
cell_phone: '<string>',
email: '<string>',
personal_email: '<string>',
hr_code: '<string>',
e_social: '<string>',
employee_registration_number: '<string>',
e_social_category: '<string>',
work_shift: '<string>',
client_integration_code: '<string>',
create_exam: true,
send_email: false,
send_date: '2023-11-07T05:31:56Z',
disability_analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://public-api.salu.com.vc/dev/routes/v0/employee/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://public-api.salu.com.vc/dev/routes/v0/employee/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'gov_id' => '<string>',
'is_disabled' => true,
'admission_date' => '2023-12-25',
'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'branch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sector_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'address' => '<string>',
'address_number' => '<string>',
'address_detail' => '<string>',
'zip_code' => '<string>',
'neighborhood' => '<string>',
'state' => '<string>',
'city' => '<string>',
'social_name' => '<string>',
'birth_date' => '2023-12-25',
'mother_name' => '<string>',
'place_of_birth' => '<string>',
'phone' => '<string>',
'cell_phone' => '<string>',
'email' => '<string>',
'personal_email' => '<string>',
'hr_code' => '<string>',
'e_social' => '<string>',
'employee_registration_number' => '<string>',
'e_social_category' => '<string>',
'work_shift' => '<string>',
'client_integration_code' => '<string>',
'create_exam' => true,
'send_email' => false,
'send_date' => '2023-11-07T05:31:56Z',
'disability_analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://public-api.salu.com.vc/dev/routes/v0/employee/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://public-api.salu.com.vc/dev/routes/v0/employee/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/employee/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_disabled": true,
"status": "<string>",
"sex": "<string>",
"admission_date": "2023-12-25",
"is_active": true,
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"branch": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"position": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sector": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"social_name": "<string>",
"gov_id": "<string>",
"birth_date": "2023-12-25",
"gender": "<string>",
"mother_name": "<string>",
"marital_status": "<string>",
"place_of_birth": "<string>",
"educational_stage": "<string>",
"human_skin_tone": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"dismissal_date": "2023-12-25",
"hr_code": "<string>",
"employee_registration_number": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"address": {
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Cria um novo funcionário (Employee) na sua organização.
create_exam(boolean): quandotrue, será gerado um exame admissional para o colaborador após a criação.send_email(boolean): quandotrue, o colaborador receberá uma notificação por e-mail sobre o exame.send_date(date-time, opcional): data/hora de envio da notificação. Sesend_email=trueesend_dateestiver vazio ou nulo, usaremos a data/hora atual para disparar a comunicação.
- Campo:
send_date - Formato aceito: ISO 8601 (UTC quando aplicável)
- Exemplos válidos:
-
2025-01-31T00:00:00Z -
2025-01-31 00:00:00
-
Visão Geral
- Método:
POST - Path:
/v0/employee/ - OperationId:
public_create_employee_v0_employee__post - Autenticação: header
x-api-key(APIKeyHeaderno OpenAPI)
Campos
| Campo | Descrição |
|---|---|
gov_id (CPF) | Identificador da Pessoa / Funcionário No Brasil, toda pessoa física possui um CPF (Cadastro de Pessoa Física), que é o número de identificação do contribuinte nacional. É único por pessoa e normalmente não muda. Em nossa API, ele é exposto como gov_id. Na prática, desempenha um papel semelhante ao SSN (nos EUA) ou a um número de identificação fiscal pessoal em outros países. Ponto chave: gov_id identifica o ser humano, não a relação de trabalho. |
hr_code | “Matrícula RH” (ID interno de RH da empresa) — opcional Corresponde à Matrícula RH, que é um código interno do funcionário criado pela empresa para sistemas de RH/folha de pagamento/administrativos. Opcional (não exigido por lei). Usado para controles internos e integrações com as ferramentas de HRIS/folha de pagamento da empresa. Pode variar de empresa para empresa e pode mudar se a empresa migrar de sistemas. Pense nisso como um ID de Funcionário típico dentro de uma organização. |
employee_registration_number | “Matrícula eSocial” (ID de vínculo empregatício do governo) — obrigatório (quando aplicável) Corresponde à Matrícula eSocial, que é um identificador oficial vinculado à relação de trabalho formal sob a legislação trabalhista brasileira (CLT). Obrigatório por lei para o reporte formal de emprego (eSocial). É único por relação de trabalho (por “vínculo de trabalho”), não necessariamente por pessoa para toda a vida. Pode não estar disponível na admissão, pois geralmente é atribuído/confirmado somente após a folha de pagamento/contabilidade registrar formalmente o funcionário, incluindo o registro na CTPS. Nuance importante: Uma pessoa ( gov_id) pode existir no sistema antes que a Matrícula eSocial seja conhecida. Uma vez que o emprego é formalizado, employee_registration_number se torna a referência oficial do “lado do governo” para aquele vínculo empregatício. |
Exemplos focados em create_exam e send_email
1) Gerar exame e enviar e-mail imediatamente (sem send_date)
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/employee/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
--data '{
"name": "Maria da Silva",
"gov_id": "12345678900",
"is_disabled": false,
"status": "Ativo",
"sex": "F",
"admission_date": "2025-01-31",
"organization_id": "00000000-0000-0000-0000-000000000001",
"branch_id": "00000000-0000-0000-0000-000000000002",
"position_id": "00000000-0000-0000-0000-000000000003",
"sector_id": "00000000-0000-0000-0000-000000000004",
"create_exam": true,
"send_email": true,
"send_date": null
}'
send_email=true e send_date não foi informado.
2) Agendar envio do e-mail para uma data/hora específica
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/employee/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
--data '{
"name": "Maria da Silva",
"gov_id": "12345678900",
"is_disabled": false,
"status": "Ativo",
"sex": "F",
"admission_date": "2025-01-31",
"organization_id": "00000000-0000-0000-0000-000000000001",
"branch_id": "00000000-0000-0000-0000-000000000002",
"position_id": "00000000-0000-0000-0000-000000000003",
"sector_id": "00000000-0000-0000-0000-000000000004",
"create_exam": true,
"send_email": true,
"send_date": "2025-02-01T09:30:00Z"
}'
send_date (ISO 8601).
Campos enum e traduções
Use exatamente os valores do enum conforme definidos pela API (strings em português). As traduções/descrições abaixo servem apenas como referência de significado.
status
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
status | Ativo | Ativo |
Inativo | Inativo | |
Afastado | Afastado | |
Férias | Férias | |
Pendente | Pendente |
sex
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
sex | M | Masculino |
F | Feminino |
gender
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
gender | Cis | Cisgênero |
Trans | Transgênero |
marital_status
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
marital_status | Não informado | Não informado |
Solteiro | Solteiro | |
Casado | Casado | |
Separado | Separado | |
Desquitado | Desquitado | |
Viúvo | Viúvo | |
Outros | Outros | |
Divorciado | Divorciado | |
União Estável | União estável |
educational_stage
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
educational_stage | Indefinida | Indefinida |
Ensino Fundamental Incompleto | Ensino Fundamental Incompleto | |
Ensino Fundamental Completo | Ensino Fundamental Completo | |
Ensino Medio Incompleto | Ensino Médio Incompleto | |
Ensino Medio Completo | Ensino Médio Completo | |
Ensino Superior Incompleto | Ensino Superior Incompleto | |
Ensino Superior Completo | Ensino Superior Completo | |
Profissionalizante | Profissionalizante | |
Técnico Incompleto | Técnico Incompleto | |
Técnico Completo | Técnico Completo | |
Tecnólogo Incompleto | Tecnólogo Incompleto | |
Tecnólogo Completo | Tecnólogo Completo | |
Pós-graduação Incompleta | Pós-graduação Incompleta | |
Pós-graduação Completo | Pós-graduação Completo | |
Mestrado Incompleto | Mestrado Incompleto | |
Mestrado Completo | Mestrado Completo | |
Doutorado Incompleto | Doutorado Incompleto | |
Doutorado Completo | Doutorado Completo | |
PHD Incompleto | PHD Incompleto | |
PHD Completo | PHD Completo | |
Não Informado | Não informado | |
Analfabeto | Analfabeto |
human_skin_tone
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
human_skin_tone | Indefinido | Indefinido |
Branca | Branca | |
Preta | Preta | |
Parda | Parda | |
Amarela | Amarela | |
Indígena | Indígena | |
Mulato | Mulato |
contract_type
| Campo (request) | Valores permitidos (enum da API) | Significado (PT) |
|---|---|---|
contract_type | CLT | Emprego pela CLT |
COOPERADO | Cooperado | |
TERCERIZADO | Terceirizado | |
AUTONOMO | Autônomo | |
TEMPORARIO | Temporário | |
PESSOA_JURIDICA | Pessoa Jurídica | |
ESTAGIARIO | Estagiário | |
MENOR_APRENDIZ | Menor aprendiz | |
ESTATUTARIO | Servidor estatutário | |
COMISSIONADO_INTERNO | Comissionado interno | |
COMISSIONADO_EXTERNO | Comissionado externo | |
APOSENTADO | Aposentado | |
APOSENTADO_INATIVO_PREFEITURA | Aposentado inativo (prefeitura) | |
PENSIONISTA | Pensionista | |
SERVIDOR_PUBLICO_EFETIVO | Servidor público efetivo | |
EXTRANUMERARIO | Extranumerário | |
AUTARQUICO | Servidor autárquico | |
INATIVO | Inativo | |
TITULO_PRECARIO | Título precário | |
SERVIDOR_ADM_CENTRALIZADA_OU_DESCENTRALIZADA | Servidor da administração centralizada ou descentralizada |
Exemplo de requisição
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/employee/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
--data '{
"employee_name": "Maria da Silva",
"employee_registration_number": "12345",
"employee_is_disabled": false
}'
Authorizations
Body
application/json
Available options:
Ativo, Inativo, Afastado, Férias, Pendente Available options:
M, F Available options:
Cis, Trans Available options:
Não informado, Solteiro, Casado, Separado, Desquitado, Viúvo, Outros, Divorciado, União Estável Available options:
Indefinida, Ensino Fundamental Incompleto, Ensino Fundamental Completo, Ensino Medio Incompleto, Ensino Medio Completo, Ensino Superior Incompleto, Ensino Superior Completo, Profissionalizante, Técnico Incompleto, Técnico Completo, Tecnólogo Incompleto, Tecnólogo Completo, Pós-graduação Incompleta, Pós-graduação Completo, Mestrado Incompleto, Mestrado Completo, Doutorado Incompleto, Doutorado Completo, PHD Incompleto, PHD Completo, Não Informado, Analfabeto Available options:
Indefinido, Branca, Preta, Parda, Amarela, Indígena, Mulato Available options:
CLT, COOPERADO, TERCERIZADO, AUTONOMO, TEMPORARIO, PESSOA_JURIDICA, ESTAGIARIO, MENOR_APRENDIZ, ESTATUTARIO, COMISSIONADO_INTERNO, COMISSIONADO_EXTERNO, APOSENTADO, APOSENTADO_INATIVO_PREFEITURA, PENSIONISTA, SERVIDOR_PUBLICO_EFETIVO, EXTRANUMERARIO, AUTARQUICO, INATIVO, TITULO_PRECARIO, SERVIDOR_ADM_CENTRALIZADA_OU_DESCENTRALIZADA ID da análise PCD aprovada vinculada ao colaborador. Obrigatório quando is_disabled=true e o customer exige pré-análise.
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I