Ашық API

Кілттер, webhook және қосу мысалдары.

Нұсқаулықтар

• API кілтін жасау: тек оқу немесе оқу және жазу

  КБП CRM-де API кілтін қалай жасау: атауы, «тек оқу» немесе «оқу және жазу» қолжетімділігі. Кілт бір рет көрсетіледі — оны тек серверде сақтаңыз.

• API кілтін кері қайтару

  КБП CRM-де API кілтін қалай кері қайтару: «Кері қайтару» түймесі — оны пайдаланатын бағдарламалар CRM-мен жұмыс істемей қалады.

• Webhook: CRM оқиғалар туралы өзі хабарлайды

  КБП CRM-де webhook-ты қалай қосу: https мекенжайы, оқиғалар, «Тексеру», жеткізу журналы, өшіру. CRM мәміле немесе клиент деректерімен POST жібереді.

Шолулар

• API арқылы не істеуге болады

  КБП CRM ашық API: тақталар, мәмілелер, клиенттер, түсініктемелер мен істер — алу, жасау және өзгерту; оқиғалар туралы webhook. Тегін.

• Кілт сұрауларының журналы

  КБП CRM-дегі API кілті сұрауларының журналы: қашан, қандай сұрау, жауап және IP — 30 күн. Кілттер тізіміндегі соңғы сұрау және сұраулар саны.

• Webhook қолтаңбасын тексеру (X-KBP-Signature)

  Webhook КБП CRM-нен келгенін қалай тексеру: X-KBP-Signature тақырыбы, webhook құпиясымен «уақыт.дене» жолынан HMAC-SHA256, уақыт 5 минуттан ескі емес.

• Мысал: API арқылы сайттан өтінімдер

  Сайттан өтінімдерді КБП CRM-ге қашан API арқылы беру керек, ал қашан өтінім пішіні жеткілікті. Не беру керек: бірінші кезеңдегі клиент пен мәміле.

• Мысал: 1С-пен байланыс

  КБП CRM-ді 1С-пен API арқылы қалай байланыстыру: 1С-тен CRM-ге және кері не беру керек, 1С құжатынан мәміле жасау.

• Мысал: CRM-дегі Kaspi тапсырыстары

  Kaspi.kz тапсырыстарын КБП CRM-де қалай алу: есеп бағдарламасы немесе скрипт тапсырыстарды алып, API арқылы мәмілелер жасайды.

Сұрақтар мен CRM хабарламалары

• Webhook өздігінен өшті

  КБП CRM webhook-ы неге өздігінен өшті: қатарынан 50 сәтсіз жеткізу. Серверде нені тексеру және қалай қайта қосу.

• «Тым жиі» және «API кілті жарамсыз»

  КБП CRM API қателері: 429 — минутына 300-ден көп сұрау, 401 — кілт кері қайтарылған немесе жарамсыз, 403 — құқық жоқ немесе кілт «тек оқу».