Connect Koha library system

A step-by-step guide with pictures, from the Speakvora agent's own Connect tab.

Short answer: This connects your own Koha Community (open source) account to your Speakvora agent. Then a customer can text where is order 1234 and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Koha Community (open source). Only.

Every key, number and name in the pictures is a made-up example. Nothing here asks you to share a real key with anyone but the app on your own computer.

This connects your own Koha Community (open source) account to your Speakvora agent. Then a customer can text *where is order 1234* and get the answer in seconds, and the agent can send status and tracking texts. The agent only reads. It can never create, change or delete anything in Koha Community (open source). Only the status word and the order number are ever texted back, never names, prices, items or addresses.

TIP: You need about 15 minutes, a computer, and the sign-in for your Koha Community (open source) account (the owner or a manager). You can't break anything: if a step does not work, nothing has changed and you can just try again. The keys and screens below are made-up examples.

NOTE: This guide was written from Koha Community (open source)'s public developer documentation (a few details could not be confirmed) and has not been tried yet on a live Koha Community (open source) account. If a screen looks different from what is described, press Connect, then Download report, and send it to support. We fix it for everyone.

Who this is for: library museum tourism. How Koha Community (open source) gives access: You create the key yourself in your own account; no approval is needed. What it costs you: Koha is free open source software; the REST API is built in. Your library or hosting vendor may charge to change settings.

Part 1. Get your key from Koha Community (open source)

Do this on your computer, in a new browser tab, signed in to Koha Community (open source).

  1. Sign in to the Koha staff interface as a librarian with administrator rights.
  2. Open Administration, then Global system preferences, then Web services, and make sure the REST API is turned on (RESTOAuth2ClientCredentials for OAuth2; basic authentication also has its own preference).
  3. Open Patrons and create a dedicated staff account named Speakvora.
  4. Open that account, choose More, then Set permissions, and tick only read-only permissions such as catalogue and circulate viewing.
  5. If your library uses OAuth2, open More, then Manage API keys on that account, add a description and Save to get a client ID and secret.
  6. Enter your Koha web address and the account details here; if your library only allows OAuth2, ask Speakvora support to enable it for you.

WARNING: If Koha Community (open source) asks which permissions to give, tick only the read-only ones: catalogue: read, circulate: read-only access to checkouts and holds (confirm against your Koha version). Never give write or admin access.

TIP: To copy the key, click inside the box that shows it, press Command + C on a Mac or Ctrl + C on Windows (or right-click and choose Copy). Nothing will look different. It is now in your clipboard, ready to paste. Keep it private: anyone who has it can read your orders.

Part 2. Open the Connect tab in your agent

  1. Open your agent's dashboard (the page you open from the Start Speakvora Agent file).
  2. Press Connect in the menu. On a phone the menu is the bar along the top; slide it sideways if you do not see Connect.
  3. Step 1: press Connect (1)

  4. Under Your apps type Koha Community (open source) in the box that says Find an app (1), or scroll down the list.
  5. Step 2: the Find an app box (1)

  6. Press Koha library system. A card slides up. (If you only see apps for your own kind of business, that is on purpose: your agent only shows the systems that make sense for it.)
  7. Step 3: an app's card. The Full Guide button (1) opens this page.

Part 3. Paste it in

3 boxes to fill in. Click inside a box, press Command + V on a Mac or Ctrl + V on Windows, then move to the next:

  1. Your Koha web address. The address of your Koha catalogue (OPAC or staff site, whichever serves /api/v1), without https://.
  2. API user login. Username of a dedicated staff account with read-only permissions.
  3. API user password (secret: it stays on this computer and is never shown again, only the last few characters). Password of that dedicated account.
  4. Part 3: each numbered box is one thing to paste. These are made-up examples.

TIP: Pasted by mistake into the wrong box? Click the box, press Command + A (Ctrl + A on Windows) to select all, then paste again.

Part 4. Test it

  1. Press the orange Save and test button.
  2. Koha Community (open source) has no safe read-only check we can run, so nothing is called. The connection is used for real the first time a customer asks about an order, and any problem shows in Activity.
  3. Part 4: the green message under the buttons means it worked (1)

YOU SHOULD SEE: green words starting with Connected. (here: *Saved* and the sentence about the first customer)

WARNING: Red words mean it did not work yet. Read them, then see If something is wrong below. Nothing bad happened.

What happens next

  • A customer texts something like where is order 1234. The agent answers *Your order 1234 is preparing.* (the status word from Koha Community (open source)), or *I could not find that order. A team member will check and reply.*
  • Each person can ask five times an hour. If Koha Community (open source) is down, the conversation carries on and the problem is written to Activity.
  • Mode: the agent asks Koha Community (open source) when a customer asks.

If something is wrong

  • It says the key was refused (401 or 403): copy the key again from Koha Community (open source). Make sure there is no space before or after it, and that it is a live key for the right shop or location.
  • It cannot find an order (404): the number is not in Koha Community (open source), or Koha Community (open source) uses a longer number than the one on the receipt.
  • It says too many requests (429): wait a minute and press Save and test again.
  • Koha Community (open source) says you need a plan or approval: Koha is self-hosted, so each library has its own address. The official manual and API reference confirm the /api/v1 base path, the /checkouts/{checkout_id}, /holds and /patrons/{patron_id} endpoints, and OAuth2 client credentials (token at /oauth/token). The exact status fields and permission names, and basic-auth settings (RESTBasicAuth), were not confirmed in the pages read, and the OAuth2 token exchange is not supported by this connector yet, so no test or order call is set.
  • Still stuck? Press Connect, then Download report, and email it to support. It never contains keys or customer messages.

If your plan has no API

  • Ask your library or Koha hosting vendor to enable the REST API and create a read-only account.
  • Use the staff client's holds and checkouts reports for manual status answers.

Koha Community (open source)'s own instructions: https://koha-community.org/manual/latest/en/html/webservices.html

All help guides · Every agent feature · AI receptionist by industry

Questions

What if this happens: It says the key was refused (401 or 403)?

copy the key again from Koha Community (open source). Make sure there is no space before or after it, and that it is a live key for the right shop or location.

What if this happens: It cannot find an order (404)?

the number is not in Koha Community (open source), or Koha Community (open source) uses a longer number than the one on the receipt.

What if this happens: It says too many requests (429)?

wait a minute and press Save and test again.

What if this happens: Koha Community (open source) says you need a plan or approval?

Koha is self-hosted, so each library has its own address. The official manual and API reference confirm the /api/v1 base path, the /checkouts/{checkout_id}, /holds and /patrons/{patron_id} endpoints, and OAuth2 client credentials (token at /oauth/token). The exact status fields and permission names, and basic-auth settings (RESTBasicAuth), were not confirmed in the pages read, and the OAuth2 token exchange is not supported by this connector yet, so no test or order call is set.

What if this happens: Still stuck??

Press Connect, then Download report, and email it to support. It never contains keys or customer messages.