api_get_company – Proxima Research Qazaqstan

Ең болмағанда бір рет барылған ұйымдардың (компаниялардың) тізімін қайтарады. Визит кезеңіне қатысты шектеулер жоқ.

Сұраныс

Endpoint

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

Аутентификация

Bearer Token (міндетті)

Сұраныс құрылымы

Тақырыптар

Кілт	Мән
Authorization	Bearer `<token>`
Content-Type	application/json

Сұраныс денесі

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

Өріс	Түрі	Міндетті	Сипаттамасы
function	string	Иә	Әдіс атауы — "api_get_company"
format	string	Иә	Жауап форматы — csv
arguments	object	Жоқ	Әдіске тән қосымша параметрлер
ids	string	Жоқ	Компания ID тізімі. Көрсетілмесе — барлық барылған компаниялар қайтарылады

Сәтті жауап

200 OK

CSV форматында жүйе барылған ұйымдардың тізімін жай мәтін ретінде қайтарады.

Content-Type

text/plain

Жауап мысалы

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

Өріс	Сипаттамасы
company_name	Ұйым атауы
company_type	Ұйым түрі (мыс.: дәріхана, клиника)
company_address	Мекен-жайы
company_categ	Жалпы санат
company_categ_by_direction	Өнім бағыты бойынша санат
company_code	Заңды тұлғаның салық нөмірі
company_chain	Желінің атауы
comapny_main	Бас ұйым
isarchive	Архив белгісі
company_isshop	Сауда нүктесі (1 = иә)
company_morionid	Axioma базасындағы ID
company_region	Әкімшілік аймақ
company_city	Қала
company_phone	Байланыс нөмірі
company_gps_lat	Ендік
company_gps_lng	Бойдтық
company_id	Proxima CRM ішкі ID

Қате жауап

40x/50x

{
  "message": "string"
}

Код	Сипаттамасы
400-499	Клиент қатесі
500-599	Сервер қатесі

Search