Jobs API

A API de vagas do Codante.io é uma API que simula uma lista de vagas de emprego. A API responde com um código de status 200 para solicitações bem-sucedidas, fornecendo recursos de vagas no formato JSON, cada um contendo informações detalhadas como ID da vaga, título, empresa, localização, salário e requisitos.

Para solicitações inválidas, a API retorna um código de status 422, garantindo um feedback claro sobre erros nos parâmetros fornecidos.

Vale lembrar que a base de dados é resetada a cada quatro horas - então os dados não serão persistentes por muito tempo.

Autenticação

A API de vagas do Codante.io não requer autenticação para acessar as vagas.

Rate Limit

A API de vagas do Codante.io possui um limite de taxa de 100 solicitações por minuto. Se você exceder esse limite, receberá um código de status 429. O uso indiscriminado também poderá levar ao bloqueio do seu IP.

Base URL

A URL base para a API de vagas do Codante.io é https://apis.codante.io/api/job-board.

O model Job (Vaga)

O model Job contém todas as informações sobre uma vaga de emprego.

Propriedades

  • Name
    id
    Type
    integer
    Description

    Identificador único da vaga.

  • Name
    title
    Type
    string
    Description

    Título da vaga.

  • Name
    company
    Type
    string
    Description

    Nome da empresa que está contratando.

  • Name
    company_website
    Type
    string
    Description

    URL do site da empresa.

  • Name
    city
    Type
    string
    Description

    Cidade onde a vaga está localizada.

  • Name
    schedule
    Type
    string
    Description

    Tipo de contrato. Pode ser 'full-time', 'part-time', 'contract' ou 'internship'.

  • Name
    salary
    Type
    integer
    Description

    Salário mensal da vaga em reais.

  • Name
    description
    Type
    string
    Description

    Descrição detalhada da vaga.

  • Name
    requirements
    Type
    string
    Description

    Requisitos necessários para a vaga.

  • Name
    created_at
    Type
    timestamp
    Description

    Data e hora de criação do registro da vaga.

  • Name
    updated_at
    Type
    timestamp
    Description

    Data e hora da última atualização do registro.

GET/job-board/jobs

Listagem de vagas

Este endpoint retorna uma lista de todas as vagas disponíveis.

Request

GET
/job-board/jobs
curl -G https://apis.codante.io/api/job-board/jobs

Response

{
  "data": [
    {
      "id": 3,
      "title": "Desenvolvedor Backend",
      "company": "Amazon",
      "company_website": "https://amazon.com",
      "city": "Seattle",
      "schedule": "full-time",
      "salary": 8000,
      "description": "Estamos procurando um desenvolvedor backend para se juntar à nossa equipe.",
      "requirements": "Experiência com PHP, Laravel",
      "created_at": "2025-01-14T21:14:11.000000Z",
      "updated_at": "2025-01-14T21:14:11.000000Z"
    }
  ]
}
GET/job-board/jobs/{id}

Vaga Individual

Este endpoint retorna uma vaga específica.

Request

GET
/job-board/jobs/{id}
curl -G https://apis.codante.io/api/job-board/jobs/3

Response

{
  "data": {
    "id": 3,
    "title": "Desenvolvedor Backend",
    "company": "Amazon",
    "company_website": "https://amazon.com",
    "city": "Seattle",
    "schedule": "full-time",
    "salary": 8000,
    "description": "Estamos procurando um desenvolvedor backend para se juntar à nossa equipe.",
    "requirements": "Experiência com PHP, Laravel",
    "created_at": "2025-01-14T21:14:11.000000Z",
    "updated_at": "2025-01-14T21:14:11.000000Z"
  }
}
POST/job-board/jobs

Criar Vaga

Este endpoint cria uma nova vaga. Retorna código de status 201 para sucesso e 422 para falha.

Request

POST
/job-board/jobs
curl -X "POST" https://apis.codante.io/api/job-board/jobs \
  -d "title=Desenvolvedor Backend" \
  -d "company=Amazon" \
  -d "company_website=https://amazon.com" \
  -d "city=Seattle" \
  -d "schedule=full-time" \
  -d "salary=8000" \
  -d "description=Estamos procurando..." \
  -d "requirements=Experiência com PHP, Laravel"

Response

{
  "data": {
    "id": 3,
    "title": "Desenvolvedor Backend",
    "company": "Amazon",
    "company_website": "https://amazon.com",
    "city": "Seattle",
    "schedule": "full-time",
    "salary": 8000,
    "description": "Estamos procurando um desenvolvedor backend para se juntar à nossa equipe.",
    "requirements": "Experiência com PHP, Laravel",
    "created_at": "2025-01-14T21:14:11.000000Z",
    "updated_at": "2025-01-14T21:14:11.000000Z"
  }
}
DELETE/job-board/jobs/{id}

Apagar Vaga

Este endpoint apaga uma vaga específica. Retorna código de status 204 para sucesso e 404 caso a vaga não seja encontrada.

Request

DELETE
/job-board/jobs/{id}
curl -X DELETE https://apis.codante.io/api/job-board/jobs/3

Response

// Retorna 204 No Content