{"id":4767,"date":"2021-12-26T19:13:25","date_gmt":"2021-12-26T17:13:25","guid":{"rendered":"https:\/\/www.kananas.com\/en\/documentation-5\/api\/"},"modified":"2024-09-02T16:55:09","modified_gmt":"2024-09-02T14:55:09","slug":"api","status":"publish","type":"page","link":"https:\/\/www.kananas.com\/en\/documentation\/api\/","title":{"rendered":"API"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">Kananas offers developers its RESTful API: <a href=\"https:\/\/documenter.getpostman.com\/view\/2s93Xu3RTX?version=latest#3fd0f8c0-05cf-4791-bd81-52c52c5a44eb\" target=\"_blank\" rel=\"noopener\">detailed documentation of the Kananas API<\/a><\/p>\n\n\n\n<p class=\"wp-block-paragraph\">This API allows you to connect another software to your Kananas account to retrieve information or perform certain functions: list of contacts, expense creation, etc&#8230;<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Access to the API is subject to obtaining a secret key that you can set via the <mark style=\"background-color:var(--accent)\" class=\"has-inline-color has-base-3-color\">Parameters\/API<\/mark> menu.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter\"><img decoding=\"async\" src=\"http:\/\/www.kananas.com\/wp-content\/uploads\/2021\/12\/Screenshot-2021-12-26-at-18-08-09-SOA-motor-chapter-Parame\u0301trage-Mon-compte-Options-1024x141.png\" alt=\"api secret key\" class=\"wp-image-3220\"\/><\/figure>\n<\/div>\n\n\n<p class=\"wp-block-paragraph\">This key must be used for each API call by passing it in the request header.<\/p>\n\n\n<div class=\"su-box su-box-style-default\" id=\"\" style=\"border-color:#000000;border-radius:3px;max-width:none\"><div class=\"su-box-title\" style=\"background-color:#333333;color:#FFFFFF;border-top-left-radius:1px;border-top-right-radius:1px\">Example<\/div><div class=\"su-box-content su-u-clearfix su-u-trim\" style=\"border-bottom-left-radius:1px;border-bottom-right-radius:1px\">curl &#8211;request GET<br \/>\n&#8211;url &lsquo;https:\/\/backoffice.kananas.com\/action_manager.php?event=api&amp;request=contacts&rsquo;<br \/>\n&#8211;header &lsquo;Accept: application\/json&rsquo;<br \/>\n&#8211;header &lsquo;token: SECRET_KEY&rsquo;<\/div><\/div>\n\n\n\n<div style=\"height:30px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\">Webhooks:<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">In addition to the API, we also offer webhooks. This is a mechanism that allows sending changes made in Kananas to other applications.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">Webhooks can be configured on the <mark style=\"background-color:var(--accent)\" class=\"has-inline-color has-base-3-color\">Parameters\/API<\/mark> page. This functionality is only accessible to the administrator user.<\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"599\" src=\"https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-09-02-at-16-44-54-SOA-club-Parameter-_-API-1024x599.png\" alt=\"\" class=\"wp-image-6055\" srcset=\"https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-09-02-at-16-44-54-SOA-club-Parameter-_-API-1024x599.png 1024w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-09-02-at-16-44-54-SOA-club-Parameter-_-API-300x175.png 300w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-09-02-at-16-44-54-SOA-club-Parameter-_-API-768x449.png 768w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-09-02-at-16-44-54-SOA-club-Parameter-_-API-1536x898.png 1536w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-09-02-at-16-44-54-SOA-club-Parameter-_-API-2048x1197.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n<\/div>\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\">Webhooks offer several advantages:<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Webhooks offer several advantages:<\/li>\n\n\n\n<li>Real-time notifications: Webhooks allow an application to receive real-time notifications when an event occurs on another system or service. This allows the application to react immediately to the event and take action accordingly, such as the online registration of a new contact.<\/li>\n\n\n\n<li>Traffic reduction: Webhooks help avoid polluting servers with regular queries to check if new data is available. Instead, data is sent to the application when it&rsquo;s available, reducing network traffic.<\/li>\n\n\n\n<li>Flexibility: Webhooks offer great flexibility for developers. They can choose the events for which they want to receive notifications.<\/li>\n\n\n\n<li>Task automation: Webhooks allow scheduling automated tasks that run in response to specific events. This enables the automation of tedious tasks and saves time.<\/li>\n\n\n\n<li>Easy integration: Webhooks can be easily integrated into an existing application or third-party system. They are widely supported by many applications and services, making them very popular for system integration.<\/li>\n<\/ul>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-medium\"><img loading=\"lazy\" decoding=\"async\" width=\"300\" height=\"170\" src=\"https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/zapier-workflow-300x170.png\" alt=\"\" class=\"wp-image-6057\" srcset=\"https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/zapier-workflow-300x170.png 300w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/zapier-workflow-768x435.png 768w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/zapier-workflow.png 1000w\" sizes=\"auto, (max-width: 300px) 100vw, 300px\" \/><\/figure>\n<\/div>\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h3 class=\"wp-block-heading\">Automation<\/h3>\n\n\n\n<p class=\"wp-block-paragraph\">The API can be used to extend Kananas&rsquo; functionalities through automation tools such as Zapier or Make. For example, you can retrieve data entered on a contact form on a website, send it to Kananas to create a contact, and then receive a notification.<\/p>\n\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<p class=\"wp-block-paragraph\">Example of automation created with <a href=\"https:\/\/www.make.com\/en\" target=\"_blank\" rel=\"noreferrer noopener nofollow\">make.com<\/a><\/p>\n\n\n<div class=\"wp-block-image\">\n<figure class=\"aligncenter size-large\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"858\" src=\"https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-02-22-at-10-53-44-tally-_-kananas-Zapier-1024x858.png\" alt=\"\" class=\"wp-image-6058\" srcset=\"https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-02-22-at-10-53-44-tally-_-kananas-Zapier-1024x858.png 1024w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-02-22-at-10-53-44-tally-_-kananas-Zapier-300x251.png 300w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-02-22-at-10-53-44-tally-_-kananas-Zapier-768x643.png 768w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-02-22-at-10-53-44-tally-_-kananas-Zapier-1536x1287.png 1536w, https:\/\/www.kananas.com\/en\/wp-content\/uploads\/sites\/2145\/2024\/09\/Screenshot-2024-02-22-at-10-53-44-tally-_-kananas-Zapier.png 1924w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n<\/div>\n\n\n<div style=\"height:20px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Kananas offers developers its RESTful API: detailed documentation of the Kananas API This API allows you to connect another software to your Kananas account to retrieve information or perform certain functions: list of contacts, expense creation, etc&#8230; Access to the API is subject to obtaining a secret key that you can set via the Parameters\/API &#8230; <a title=\"API\" class=\"read-more\" href=\"https:\/\/www.kananas.com\/en\/documentation\/api\/\" aria-label=\"En savoir plus sur API\">Lire la suite<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"parent":4864,"menu_order":11,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","footnotes":""},"class_list":["post-4767","page","type-page","status-publish"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/pages\/4767","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/comments?post=4767"}],"version-history":[{"count":6,"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/pages\/4767\/revisions"}],"predecessor-version":[{"id":6062,"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/pages\/4767\/revisions\/6062"}],"up":[{"embeddable":true,"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/pages\/4864"}],"wp:attachment":[{"href":"https:\/\/www.kananas.com\/en\/wp-json\/wp\/v2\/media?parent=4767"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}