Versão: 1.0.7
Última Atualização: 01 Jul, 2024

Início

    API Endpoint

        https://api.wportal.pt/v1

A API Wportal permite o acesso a informação proveniente do software Whumanos.

Para utilizar esta API deverá utilizar o método de autentenção Basic Authentication, no qual os dados de acesso são fornecidos pela wincode. Pode entrar em contacto com o webmaster através do seguinte endereço: web@wincode.pt.

Postman: Documentação

Postman: Testar Api Portal de Empregos

get empregos


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/empregos',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar ofertas de emprego:
https://api.wportal.pt/v1/empregos 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
	id: "1600000186", 
	titulo: "Gestor Imobiliário (M/F)",
	referencia: "4695525",
	local: "Lisboa",
	inicio_oferta: "2019-02-18",
	fim_oferta: "2023-12-31",
	comeco: "1901-01-01",
	anuncio: "Ser Agente é um trabalho a tempo inteiro que exige uma visão global de mercado",
	vagas: "4",
	vinculo: "Part Time",
	setor: "Hotelaria",
	cliente: "Ser Agente é um trabalho a tempo inteiro que exige uma visão global de mercado...",
	funcoes: "Angariação e venda de imóveis;\r\n- Análise de mercado e elaboração do plano...",
	requisitos: "Pessoas pró - ativas e com facilidade de comunicação;\r\n- Com ou sem experiência no sector...",
	oferta: "Rendimento médio expectável de...",
	destaque: "1",
	entrada_imediata: "0",
	valor: "750.000000",
	distrito: "AVEIRO",
	area: "GERAL",
	categoria: "Comercial"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
destaque Int (optional) Filter by destaque.
0: Sem destaque
1: Em destaque (HotJob)
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get emprego


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/empregos/1600000186',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar oferta de emprego:
https://api.wportal.pt/v1/empregos/{id} 



Result example :

{
	id: "1600000186", 
	titulo: "Gestor Imobiliário (M/F)",
	referencia: "4695525",
	local: "Lisboa",
	inicio_oferta: "2019-02-18",
	fim_oferta: "2023-12-31",
	comeco: "1901-01-01",
	anuncio: "Ser Agente é um trabalho a tempo inteiro que exige uma visão global de mercado",
	vagas: "4",
	vinculo: "Part Time",
	setor: "Hotelaria",
	cliente: "Ser Agente é um trabalho a tempo inteiro que exige uma visão global de mercado...",
	funcoes: "Angariação e venda de imóveis;\r\n- Análise de mercado e elaboração do plano...",
	requisitos: "Pessoas pró - ativas e com facilidade de comunicação;\r\n- Com ou sem experiência no sector...",
	oferta: "Rendimento médio expectável de...",
	destaque: "1",
	entrada_imediata: "0",
	valor: "750.000000",
	distrito: "AVEIRO",
	area: "GERAL",
	categoria: "Comercial"
}

get clientes


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/clientes',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar clientes:
https://api.wportal.pt/v1/clientes 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
	codigo: 1, 
	nome: "Jon",
	rua: "Rua de Teste",
	rua2: "",
	localidade: "Porto",
	codigo_postal: "4000-000 Porto",
	email: "example@example.com",
	telefone: "123456789"
	telemovel: "123456789"
	contribuinte: "123456789",
    },
  ]
}

QUERY PARAMETERS

Field Type Description
codigo String (optional) Filter by codigo.
contribuinte Int (optional) Filter by contribuinte.
email String (optional) Filter by email
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get cliente


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/clientes/00001',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar cliente:
https://api.wportal.pt/v1/clientes/{codigo} 



Result example :

{
	codigo: 1, 
	nome: "Jon",
	rua: "Rua de Teste",
	rua2: "",
	localidade: "Porto",
	codigo_postal: "4000-000 Porto",
	email: "example@example.com",
	telefone: "123456789"
	telemovel: "123456789"
	contribuinte: "123456789",
}

get clientes / locais


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/clientes/0001/locais',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar locais:
https://api.wportal.pt/v1/clientes/{codigo}/locais 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
	codigo: "0001", 
	nome: "Jon",
	codigo_cliente: "0001",
	nome_cliente: "Empresa ABC",
	morada: "Porto"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get clientes / centros custo


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/clientes/0001/ccusto',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar centros de custo:
https://api.wportal.pt/v1/clientes/{codigo}/ccusto 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    { 
	codigo: "0001", 
	nome: "Cozinhas",
	codigolocal: "000004",
	nomelocal: "Arm. Chiado - Portugália Balcão",
	codigo_cliente: "2111.000004",
	nome_cliente: "Armazens do Chiado, Lda",
	local: "Tablet Hotel",
	rua: "Rua da Liberdade",
	localidade: "Porto",
	codigo_postal: "4000-123 ",
	responsavel: "José",
	referencia: "123",
	valor_hora: 123,45
    },
  ]
}

QUERY PARAMETERS

Field Type Description
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get funcionarios


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/funcionarios',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar funcionários:
https://api.wportal.pt/v1/funcionarios 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
	codigo: 1, 
	nome: "Jon",
	rua: "Rua de Teste",
	rua2: "",
	localidade: "Porto",
	codigo_postal: "4000-000 Porto",
	email: "example@example.com",
	telefone: "123456789"
	telemovel: "123456789"
	data_nascimento: "01-01-2000",
	sexo: "M",
	contribuinte: "123456789",
	cartao_europeu: "123456789"
	estado_civil: "Casado(a)",
	dependentes: "0",
	codigo_categoria: "0001",
	descricao_categoria: "Sample", 
	codigo_categoria_area: "0009",
	descricao_categoria_area: "Construção e Obras Publicas", 
	data_admissao: "01-01-2020",
	data_demissao: "",
	custo_hora: "9.9999",
	custo_mes: "635.000000",
	estabelecimento: "Porto",
	diuturnidades: "1.500000",
	assinado: "1",
	codigo_local: "000259"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
codigo String (optional) Filter by codigo.
contribuinte Int (optional) Filter by contribuinte.
email String (optional) Filter by email
estado int (optional) Filter by estado contrato
1: ativo
2: terminado
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get funcionario


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/funcionarios/00001',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar funcionário:
https://api.wportal.pt/v1/funcionarios/{codigo} 



Result example :

{
	codigo: "00001", 
	nome: "Jon",
	rua: "Rua de Teste",
	rua2: "",
	localidade: "Porto",
	codigo_postal: "4000-000 Porto",
	email: "example@example.com",
	telefone: "123456789"
	telemovel: "123456789"
	data_nascimento: "01-01-2000",
	sexo: "M",
	contribuinte: "123456789",
	cartao_europeu: "123456789",
	estado_civil: "Casado(a)",
	dependentes: "0",
	codigo_categoria: "0001",
	descricao_categoria: "Sample", 
	data_admissao: "01-01-2020",
	data_demissao: "",
	custo_hora: "9.9999",
	custo_mes: "635.000000",
	estabelecimento: "Porto"
	diuturnidades: "1.500000",
	assinado: "1",
	codigo_local: "000259"
}

get candidatos


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidatos',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar candidatos:
https://api.wportal.pt/v1/candidatos 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
		codigo: "000003", 
		nome: "Bruno Ferreira",
		rua: "R. Manuel Parada",
		localidade: "Porto",
		codigo_postal: "2819-505",
		email: "bruno@exemplo.com",
		telefone: "123456789",
		telemovel: "123456789",
		contribuinte: "233981969",
		data_nascimento: "1992-03-25",
		codigo_nacionalidade: "PT",
		nacionalidade: "PORTUGUESA",
		codigo_categoria: "0062",
		categoria: "Copeiro(a)",
		codigo_habilitacoes: "000530",
		habilitacoes: "Professor",
		cartao_cidadao_numero: "",
		cartao_cidadao_arquivo: "",
		cartao_cidadao_validade: "1901-01-01",
		seguranca_social_numero: ""
    },
  ]
}

QUERY PARAMETERS

Field Type Description
codigo String (optional) Filter by codigo.
contribuinte Int (optional) Filter by contribuinte.
email String (optional) Filter by email
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get candidato


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidatos/00001',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar candidato:
https://api.wportal.pt/v1/candidatos/{codigo} 



Result example :

{
		codigo: "000003", 
		nome: "Bruno Ferreira",
		rua: "R. Manuel Parada",
		localidade: "Porto",
		codigo_postal: "2819-505",
		email: "bruno@exemplo.com",
		telefone: "123456789",
		telemovel: "123456789",
		contribuinte: "233981969",
		data_nascimento: "1992-03-25",
		codigo_nacionalidade: "PT",
		nacionalidade: "PORTUGUESA",
		codigo_categoria: "0062",
		categoria: "Copeiro(a)",
		codigo_habilitacoes: "000530",
		habilitacoes: "Professor",
		cartao_cidadao_numero: "",
		cartao_cidadao_arquivo: "",
		cartao_cidadao_validade: "1901-01-01",
		seguranca_social_numero: ""
}

get categorias


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/categorias',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar categorias:
https://api.wportal.pt/v1/categorias 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
	codigo: "0001", 
	descricao: "Ajudante",
	codigo_area: "0001",
	descricao_area: "Geral"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
codigo String (optional) Filter by codigo.
codigo_area String (optional) Filter by codigo_area.
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

get nacionalidades


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/nacionalidades',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar nacionalidades:
https://api.wportal.pt/v1/nacionalidades 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
       codigo: "PT", 
       nacionalidade: "PORTUGUESA"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
codigo String (optional) Filter by ID.

get habilitacoes


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/habilitacoes',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar habilitações:
https://api.wportal.pt/v1/habilitacoes 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
       codigo: "000012", 
       habilitacao: "SABE S 1.CL ENS BAS"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
codigo String (optional) Filter by ID.

get artigos


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/artigos',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar artigos:
https://api.wportal.pt/v1/artigos 



Result example :

{
  offset: 0,
  count_total: 50,
  count": 2
  rows: [
    {
	codigo: 1, 
	nome: "Playstation 5",
	preco: "0.00000",
	associado: "",
	negocio: "",
	produto: "",
	familia: "PS501",
	caucao: "remote, charger",
	caucao_preco: "0.00000"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 1000) A limit on the number of objects to be returned.

get candidatosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidatosnet',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar candidatos web:
https://api.wportal.pt/v1/candidatosnet 



Result example :

{
  offset: 0,
  count_total: 2,
  count": 2
  rows: [
    {
		ID: "1", 
		nome: "Bruno Ferreira",
		rua: "Rua de Cima",
		localidade: "Rio Meão",
		codigo_postal: "4520-463",
		email: "bruno@exemplo.com",
		telefone: "123456789",
		telemovel: "123456789",
		contribuinte: "999999999",
		data_nascimento: '1993-11-11 00:00:00',
		codigo_nacionalidade: "PT",
		nacionalidade: "PORTUGUESA",
		codigo_categoria: "",
		categoria: null,
		codigo_habilitacoes: "111",
		habilitacoes: "NÃO SABE LER NEM ESCREVER",
		cartao_cidadao_numero: "",
		cartao_cidadao_arquivo: "",
		cartao_cidadao_validade: '1901-01-01 00:00:00',
		seguranca_social_numero: "123456789",
		cv_nome: "original_filename.pdf",
		cv_download_url: "https://www.example.com/download/token"
    },
  ]
}

QUERY PARAMETERS

Field Type Description
ID Int (optional) Filter by ID.
contribuinte Int (optional) Filter by contribuinte.
email String (optional) Filter by email
password String (optional) Filter by password
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

post candidatosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidatosnet',
CURLOPT_CUSTOMREQUEST => 'POST',

Serviço para inserir candidatos web (insert):
https://api.wportal.pt/v1/candidatosnet 



Result example :

{
    error: false,
    status: 1,
    insertId: 92,
    message: "Registo(s) inserido(s) com sucesso."
}

POST PARAMETERS

Field Type Description
nome String (required)
email String (required)
contribuinte Int(9) (required)
password String
rua String
localidade String
codigo_postal String
data_nascimento Date Format: Y-m-d
genero String "M" Male; "F" Female
telefone String
telemovel String
codigo_nacionalidade String Get Nacionalidades
codigo_habilitacoes String Get Habilitacoes
codigo_categoria String Get Categorias
cartao_cidadao_numero String
cartao_cidadao_arquivo String
cartao_cidadao_validade Date Format: Y-m-d
seguranca_social_numero String
cv_nome String
cv_download_url String

put candidatosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidatosnet/{ID}',
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_POSTFIELDS =>'{"nome":"John Doe"}',

Serviço para atualizar candidatos web (update):
https://api.wportal.pt/v1/candidatosnet/{ID} 



Result example :

{
    error: false,
    status: 1,
    message: "Registo(s) atualizado(s) com sucesso."
}

JSON PARAMETERS

Field Type Description
nome String
email String
contribuinte Int(9)
password String
rua String
localidade String
codigo_postal String
data_nascimento Date Format: Y-m-d
genero String "M" Male; "F" Female
telefone String
telemovel String
codigo_nacionalidade String Get Nacionalidades
codigo_habilitacoes String Get Habilitacoes
codigo_categoria String Get Categorias
cartao_cidadao_numero String
cartao_cidadao_arquivo String
cartao_cidadao_validade Date Format: Y-m-d
seguranca_social_numero String
cv_nome String
cv_download_url String

get candidaturasnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidaturasnet',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar candidaturas web:
https://api.wportal.pt/v1/candidaturasnet 



Result example :

{
  offset: 0,
  count_total: 2,
  count": 2
  rows: [
    {
		candidatura": "1",
		candidato": "1",
		nome_candidato": "Bruno Ferreira",
		emprego": "1700000419",
		titulo_emprego": "1 vaga(s) para Pintor 1ª",
		data_candidatura": '2019-05-27 18:06:54'
    },
  ]
}

QUERY PARAMETERS

Field Type Description
candidato Int (optional) Filter by candidato.
emprego Int (optional) Filter by emprego.

post candidaturasnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidaturasnet',
CURLOPT_CUSTOMREQUEST => 'POST',

Serviço para inserir candidaturas web (insert):
https://api.wportal.pt/v1/candidaturasnet 



Result example :

{
    error: false,
    status: 1,
    insertId: 221,
    message: "Registo(s) inserido(s) com sucesso."
}

POST PARAMETERS

Field Type Description
candidato String (required) Get Candidatosnet
emprego String (required) Get Empregos

delete candidaturasnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/candidaturasnet',
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_POSTFIELDS =>'{"candidato":"91","emprego":"1600000186"}',

Serviço para eliminar candidaturas web (delete):
https://api.wportal.pt/v1/candidaturasnet 



Result example :

{
    error: false,
    status: 1,
    message: "Registo(s) eliminado(s) com sucesso."
}

JSON PARAMETERS

Field Type Description
candidato String (required) Get Candidatosnet
emprego String (required) Get Empregos

get pedidosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/pedidosnet',
CURLOPT_CUSTOMREQUEST => 'GET',

Serviço para consultar pedidos web:
https://api.wportal.pt/v1/pedidosnet 



Result example :

{
  offset: 0,
  count_total: 2,
  count": 2
  rows: [
    {
		pedido: "1", 
		data: "2024-06-05T13 48 28 960Z",
		resolvido: "0",
		artigos: [
		    {
			   codigo: "01170024",
			   descricao: "Parafuso",
			   quantidade: "2.00000"
			}
			{
			   codigo: "01170025",
			   descricao: "Prego",
			   quantidade: "10.00000"
			}
		]
    },
  ]
}

QUERY PARAMETERS

Field Type Description
curpage Integer (optional - default: 1) Current page to show.
limit Integer (optional - default: 200) A limit on the number of objects to be returned.

post pedidosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/pedidosnet',
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '
{
    "artigos":[
      {
        "artigo":"01170023",
        "quantidade":5
      },
      {
        "artigo":"01170024",
        "quantidade":3
      }
    ]
}'

Serviço para inserir pedidos web (insert)::
https://api.wportal.pt/v1/pedidosnet 




Result example :

{
    error: false,
    status: 1,
    insertId: 221,
    message: "Registo(s) inserido(s) com sucesso."
}

JSON PARAMETERS

Field Type Description
artigos Array
  • "artigo"
  • "quantidade"
 (required)

put pedidosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/pedidosnet',
CURLOPT_CUSTOMREQUEST => 'PUT'
CURLOPT_POSTFIELDS => '
{
    "resolvido":1,
	"numero":999
}'

Serviço para atualizar pedidos web (update):
https://api.wportal.pt/v1/pedidosnet 




Result example :

{
    error: false,
    status: 1,
    message: "Registo(s) atualizado(s) com sucesso."
}

JSON PARAMETERS

Field Type Description
resolvido Int
  • 0
  • 1
numero Int (optional)

delete pedidosnet


# Here is a curl example
CURLOPT_URL => 'https://api.wportal.pt/v1/pedidosnet',
CURLOPT_CUSTOMREQUEST => 'DELETE'
CURLOPT_POSTFIELDS => '
{
    "numero":1
}'

Serviço para eliminar pedidos web:
https://api.wportal.pt/v1/pedidosnet 




Result example :

{
    error: false,
    status: 1,
    message: "Registo(s) eliminado(s) com sucesso."
}

JSON PARAMETERS

Field Type Description
numero int (optional)

Errors

A API Wportal utiliza os seguintes códigos de erros:

Error Code Meaning
404 status bolean
error string
    • Não foram encontrados registos
400 status bolean
error string
    • Ocorreu um erro ao processar o pedido
401 status bolean
error string
    • Dados de autenticação inválidos
    • Pedido inseguro, utilize https