Step by step
Create an API key
Give your own system, such as your website, a key to Kila's API with only the access it needs. Kila shows the key once, and you can revoke it at any time.
An API key lets a system of yours, such as your website or accounting tools, talk to Kila for your business. “Each key belongs to this business and carries only the scopes you choose.” The API comes with the Growth and Enterprise plans.
Open Integrations and API, then the API keys tab
Tap Create key.
Name the key
“Give it a name you will recognise and only the scopes it needs.” Name it after what will use it, such as Website stock sync.
Steps 2 to 4 in one dialog. Tick only the scopes it needs
Each scope is one kind of access, shown with its code: Read products and prices (products:read), Read stock levels, Read customers, Create customers and Read sales and receipts. Kila starts with the first one ticked.
Tap Create key
Kila shows the key in a window of its own, such as Website stock sync is ready.
Copy the key
Shown once: “Copy it now and keep it somewhere safe. Kila stores only a fingerprint, so it cannot be shown again.” Tap Copy and paste it where your system keeps its settings.
Steps 5 and 6. The key is hidden here: never share yours. Confirm you have copied it, then tap Done
Switch on I have copied it: “Done unlocks once you confirm.”
The key is listed with the start of it, its scopes, when it was Last used (Never until your system calls Kila) and how many Requests it has made.
Webhooks
Link to this section: WebhooksWebhooks send your system news from Kila: “Kila posts signed JSON to these URLs when events happen.” On the Webhooks tab, tap Add endpoint, type your server’s URL (“Use https in production.”) and tick the Events it should receive, such as sale.completed, then tap Save. Kila shows the endpoint’s signing secret once, the same way as a key. Each endpoint then has Send test event, Deliveries, Edit and Rotate secret, and a switch to disable it.
The key is lost, leaked or no longer used
Link to this section: The key is lost, leaked or no longer usedTap Revoke next to it. Kila asks Revoke Website stock sync?: “Anything using this key stops working at once. This cannot be undone; create a new key if you need one.”
Your plan does not include the API
Link to this section: Your plan does not include the APIThe tabs say API and webhooks are not on your plan: “Connect your website, ERP or reporting tools with the API module. It is listed under Plan and modules; ask Kila to add it.”
Needs a manager
API keys are for owners and administrators. The audit log’s Security tab counts any Rejected API key.
- Integrations and API: the other connections, and the API reference tab.
- Your plan and billing: plans with the API.