api_get_pdk – Proxima Research Brazil

Obtém as informações inseridas durante a visita no cartão “Controle”.
O conjunto de parâmetros preenchidos depende das configurações do cliente específico.
Para obter a configuração específica, utilize o método api_get_entitymap.

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_pdk",
    "format": "csv",
    "arguments": {
        "date_from": "2025-08-04",
        "date_till": "2025-08-04",
        "preparation_ids": "1,2,3,4"
    }
}

Campo	Tipo	Obrigatório	Descrição
function	string	Sim	Nome do método da API. Para esta requisição use `"api_get_pdk"`.
format	string	Sim	Formato da resposta — `csv`.
arguments	object	Sim	Bloco de parâmetros.
date_from	string	Sim	Data inicial para montar a lista de visitas (pela data de início da visita). Formato: `YYYY-MM-DD`.
date_till	string	Sim	Data final para montar a lista de visitas (pela data de término da visita). Formato: `YYYY-MM-DD`.
preparation_ids	string	Não	Identificadores dos registros no Proxima CRM, separados por vírgulas. Usado para buscar informações de medicamentos específicos.

Resposta bem-sucedida

200 OK

Formato csv: a resposta é retornada como texto CSV.

Content-Type

text/plain

Exemplo de resposta

preparation_id,flag1,flag2,flag3,flag4,flag5,int1,int2,int3,str1,str2,str3,date1,date2,date3,float1,float2,float3,task_id
1,1,,,,,1,1,,,,,,,,,,,53800
3,1,,,,,2,,,,,,,,,,,,53800
10,1,,,,,3,,,,,,,,,,,,53800

Campo	Descrição
preparation_id	Identificador do medicamento na base Proxima CRM.
flag1 - flag5	Campos do tipo boolean.
int1 - int3	Campos do tipo integer.
str1 - str3	Campos do tipo string.
date1 - date3	Campos do tipo date.
float1-float3	Campos do tipo float.
task_id	ID da visita na base Proxima CRM na qual os dados foram registrados.

Resposta de erro

40x/50x

{
  "message": "string"
}

Código	Descrição
400	Requisição inválida (por exemplo, parâmetros obrigatórios ausentes).
401	Não autorizado (token inválido ou ausente).
500	Erro interno do servidor.

Pesquisa