API Empresas

Visão Geral

A API de empresas disponibiliza operações referentes para manipulação de empresas. As empresas têm recrutadores que postam oportunidades de emprego. A parte pública dessa API disponibiliza apenas uma operação no momento, que é o cadastro de uma empresa. Você também pode conferir toda documentação através do Swagger.


Operações

CRUD Métodos HTTP
Create POST

Criando/cadastrando uma empresa

curl -H 'Content-type: Content-Type: application/json' -H  'app-token: XYZ' \
     -X POST --url 'http://api.catho.com.br/v1/companies' \
     -d @/tmp/payload.json

O corpo do POST (apontado no exemplo acima como o arquivo /tmp/payload.json) é algo como:

{
  "corporate_group_id": 2,
  "documents": [
    {
      "type": "CNPJ",
      "value": "47603015000108"
    }
  ],
  "legal_name": "Catho Online LTDA.",
  "trade_name": "Catho",
  "description": "Empresa de Internet no ramo de recrutamento",
  "website": "http://www.catho.com.br/",
  "classification": {
    "economic_activity_legacy": "Financeiras",
    "economic_activity": "63.19-4-00",
    "economic_activity_secundary": [
      "63.19-4-00"
    ],
    "hiring_type": "HR",
    "size": "MICRO",
    "nationality": "NATIONAL",
    "commercial_processes": [
      "EXPORTATION",
      "IMPORTATION"
    ],
    "organizations": [
      "CATHO",
      "MANAGER"
    ]
  },
  "statistics": {
    "global_employees_quantity": 910,
    "local_employees_quantity": 10
  },
  "work_places": [
    {
      "main": true,
      "status": "ACTIVE",
      "phones": [
        "(11) 5555-5555"
      ],
      "address": {
        "street": "Alameda Juarí",
        "number": "262",
        "complement": "4º andar",
        "neighborhood": "Tamboré",
        "city": "Barueri",
        "state": "SP",
        "country": "Brasil",
        "postal_code": "06460-090"
      }
    }
  ]
}

Se a operação foi bem sucedida, o código de status HTTP retornado será um 201 com o o corpo:

{
  "id": 123
}

No caso de falha, os erros possíveis podem ser vistos na seção a seguir.


Erros

Algum erro pode ocorrer durante a tentativa de cadastro de empresa. Abaixo está uma lista de mensagem dos erros que podem ocorrer.

Mensagem
O campo Grupo econômico precisa ser do tipo Número, Null.
Documents without CNPJ, CPF, Protocol or DUNS.
O campo Razão social precisa ter o tamanho mínimo 1.
O campo Nome fantasia precisa ter o tamanho mínimo 1.
O campo Tipo de contratação precisa ter um dos valores: HR, COMPANY.
O campo Tamanho precisa ter um dos valores: Micro, Pequena, Média, Grande.
O campo Nacionalidade precisa ter um dos valores: NATIONAL, MULTINATIONAL.
O campo Processos comerciais precisa ter um dos valores: IMPORTATION, EXPORTATION.
O campo Organizações precisa ter um dos valores: Catho, Manager.
O campo Número de funcionários total precisa ser do tipo Número.
O campo Número de funcionários no local precisa ser do tipo Número.
O campo Status do escritório precisa ter um dos valores: Ativo, Inativo.
O campo Logradouro precisa ter o tamanho mínimo 1.
O campo Número do endereço precisa ter o tamanho mínimo 1.
O campo Bairro precisa ter o tamanho mínimo 1.
O campo Cidade precisa ter o tamanho mínimo 1.
O campo Estado precisa ter o tamanho mínimo 1.
O campo País precisa ter o tamanho mínimo 1.
O campo CEP precisa ter o tamanho mínimo 1.
Já existe uma empresa cadastrada com este documento.

Endpoints

No momento temos somente uma URL base, como abaixo:

Produção: http://api.catho.com.br/v1/companies