https://apigateway.vagas.com.br/v1
A API de publicação de vagas permite aos clientes do Vagas for Business publicarem vagas por meio de uma chamada HTTP no formato JSON.
Autenticação
A autenticação para utilização desta API pode ser feita de 02 maneiras:
- Client Credencials
- A vaga será criada com o usuário de identificação Admin como responsável
- Autorization Code (3-legged)
- A vaga será criada com o usuário informado na autorização como responsável
Client Credencials
Esse processo consiste em uma chamada POST direto ao gateway indicando as credencias para obter o token de acesso.
Considerando que as credencias foram criadas no gateway, basta realizar uma chamada conforme o exemplo:
curl -X POST -k -H 'Content-Type: application/x-www-form-urlencoded' -i 'https://apigateway.vagas.com.br/oauth/token' --data 'grant_type=client_credentials' -u 'client_id:client_secret'
O retorno dessa execução será:
{
"access_token": "asd23sde12e123sd",
"expires_in": 2591999,
"token_type": "Bearer"
}
Para todas as demais requisições abaixo, o access_token deve ser incluído na requisição como um atributo do HEADER em formato BEARER
Lembrando que o access_token tem um limite de tempo para uso, a informação retornada na chave expires_in indica a quantidades de segundos que o token será expirado a partir de sua data de geração.
Exemplo de chamada usando o __access_token:__
# Valor exemplo que deve ser incluido no HEADER da requisição:
# Authorization: Bearer asd23sde12e123sd
CURL example:
curl -XGET <URL TBD>
--header “Authorization: Bearer asd23sde12e123sd”
Autorization Code (3-legged)
Esse processo implementa a especificação OAuth 2.0 para autenticação e autorização.
Esta autenticação segue o padrão de "three leg":
- O serviço remoto requisita ao usuário (funcionário do Vagas For Business) para que faça a autenticação em um servidor do VAGAS API
Como obter o token
O serviço remoto inicia o processo chamando uma URL para /oauth/authorize do servidor do VAGAS API, enviando como parametros:
- client_id: Identificador da aplicação (Fornecido pela VAGAS)
- login_type: Identificador do tipo de login (deve ser enviado o valor "empresa")
- response_type: Identificador do tipo de resposta (deve ser enviado o valor "code")
- redirect_uri: URI que será redirecionado quando a ação de login for sucesso ou não
Exemplo:
https://apigateway.vagas.com.br/oauth/authorize?response_type=code&client_id=some_application_id&login_type=empresa&redirect_uri=http%3A%2F%2Flocalhost%2Foauth%2Fcode_callback
O usuário irá autenticar com suas credencias e autorizará o uso de suas informações pelo serviço remoto.
Quando o usuário aceitar a autorização, o servidor VAGAS API irá redirecionar de volta ao serviço remoto usando o endereço indicado pelo parametro redirect_uri com um código de autorização.
Exemplo:
http://localhost/oauth/code_callback?code=AixUbVTop239876
No caso de requisição não autorizada, a chamada será para o mesmo URI informado no parametro redirect_uri com o parametro de erro.
Exemplo:
http://localhost/oauth/code_callback?error=unauthorized-request
Usando o código retornado acima, o serviço remoto deve requisitar um token de acesso que será usado para todas as demais requisições.
Fazendo uma nova requisição através de um HTTP POST para a rota /oauth/token usando o formato "application/x-www-form-urlencoded" com os seguintes parametros:
- code: O código de autorização (recebido na chamada anterior)
- grant_type: Com o valor "authorization_code"
Também deve ser incluido no cabeçalho da requisição (HEADER) um atributo com as informações de client_id e client_secret concatenados por dois pontos (:) e codificado em Base64
Exemplo:
- Tendo o client_id igual a "exemplo" e um client_secret igual a "emi40QrBjUiPaVC2eGK5"
- Devem ser concatenados: exemplo:emi40QrBjUiPaVC2eGK5
- Aplicado Base64 no valor acima: ZXhlbXBsbzplbWk0MFFyQmpVaVBhVkMyZUdLNQ==
- Incluído no HEADER da requisição: Authorization: Basic ZXhlbXBsbzplbWk0MFFyQmpVaVBhVkMyZUdLNQ==
Curl Exemplo:
curl -XPOST https://apigateway.vagas.com.br/oauth/token \
--header “Authorization: Basic ZXhlbXBsbzplbWk0MFFyQmpVaVBhVkMyZUdLNQ==” \
--data “code=AixUbVTop239876&grant_type=authorization_code”
O retorno da requisição, se bem sucedida será:
{
"access_token": "asd23sde12e123sd",
"expired_in": 2591999
}
Para todas as demais requisições abaixo, o access_token deve ser incluído na requisição como um atributo do HEADER em formato BEARER
Lembrando que o access_token tem um limite de tempo para uso, a informação retornada na chave expires_in indica a quantidades de segundos que o token será expirado a partir de sua data de geração.
Exemplo de chamada usando o __access_token:__
# Valor exemplo que deve ser incluido no HEADER da requisição:
# Authorization: Bearer asd23sde12e123sd
CURL example:
curl -XGET <URL TBD>
--header “Authorization: Bearer asd23sde12e123sd”
This is version 1.0.0 of this API documentation. Last update on Sep 22, 2026.