api_get_company – Proxima Research Brazil

Retorna a lista de instituições (empresas) que foram visitadas pelo menos uma vez. Não há restrições de período de visita.

Solicitação

Endpoint

POST https://yourdomain.pharmahrm.com/crm-api/db-function/run

Autenticação

Bearer Token (obrigatório)

Estrutura da solicitação

Cabeçalhos

Chave	Valor
Authorization	Bearer `<token>`
Content-Type	application/json

Corpo da solicitação

{
  "function": "api_get_company",
  "format": "csv",
  "arguments": {
    "ids": "1,2,3,4"
  }
}

Campo	Tipo	Obrigatório	Descrição
function	string	Sim	Nome do método — "api_get_company"
format	string	Sim	Formato da resposta — csv
arguments	object	Não	Parâmetros opcionais específicos do método
ids	string	Não	Lista de IDs de empresas separadas por vírgulas. Se omitido, são retornadas todas as empresas visitadas

Resposta bem-sucedida

200 OK

O sistema retorna a lista das instituições visitadas em formato CSV como texto simples.

Content-Type

text/plain

Exemplo de resposta

company_name,company_type,company_address,company_categ,company_categ_by_direction,company_code,company_chain,company_main,isarchive,company_isshop,company_morionid,company_region,company_city,company_phone,company_gps_lat,company_gps_lng,company_country,company_id
Health Clinic,Pharmacy,Kyiv St. 12,A,B,40112233,PharmaNet,MainCorp,No,1,AXM12345,Kyiv,Kyiv,+380441234567,50.4501,30.5234,Ukraine,1033

Campo	Descrição
company_name	Nome da instituição
company_type	Tipo de instituição (ex.: farmácia, clínica)
company_address	Endereço da instituição
company_categ	Categoria geral
company_categ_by_direction	Categoria por direção do produto
company_code	Identificação fiscal (INN)
company_chain	Nome da rede
comapny_main	Instituição principal
isarchive	Indicador de arquivamento
company_isshop	Ponto comercial (1 = sim)
company_morionid	ID na base Axioma
company_region	Região administrativa
company_city	Cidade
company_phone	Telefone de contato
company_gps_lat	Latitude
company_gps_lng	Longitude
company_id	ID interno no Proxima CRM

Resposta de erro

40x/50x

{
  "message": "string"
}

Código	Descrição
400-499	Erro do cliente
500-599	Erro do servidor

Pesquisa