Creating API Keys for services

Creating API Credentials for 3rd Party Integrations

Info
There are two prerequisite system preferences for the API to be used that must be set to 'enable':
  1. RESTPublicAPI
  2. RESTOAuth2ClientCredentials
Also, the URL for the API connection is: https://yourOPACurl/api/v1/
      Example: https://libraryShortName.bywatersolutions.com/api/v1/
1. Create a patron for the service that will use the API
            Name the account Firstname: <ApplicationName> Surname: API_Account.
                        *You can also put that name in the cardnumber field.
                        *When making the patron account be sure to use a category that is either staff or systems.
                        *It needs to have an expiration date far into the future.
            Save

2. Make API keys using that new patron.
            Navigate to the More menu
            Click on API Keys
            On this page you'll "Generate a new id/secret pair"
            Give it the name <ApplicationName>
            You need to copy the Description, Client ID and Secret.
                        *This information will only EVER be available once, on this page, and once you click away it's irretrievable.
            Share this information securely with the application/service provide through their tool or by using Sharepass. (Link to Sharepass)

3. Add permissions to API account
            These differ from application to application, we are here to help with this if it isn't clear
                        *If an application states their needed permissions like 'borrowers = 1' it means it needs all the permissions for that set of permissions
                        *Look for the heading that has '(borrowers)' following the title

    • Related Articles

    • Patron Point and Koha - Library Setup

      How does it work? Patron Point can send email, SMS, and/or phone messages. Similar to SIP users, an API patron/user allows third party integrations such as Patron Point to connect to Koha. The API patron will have permissions that allow it to ...

    • Paypal Plugin for Koha

      PayPal Setup The steps below will walk you through setting up the PayPal business account. PayPal Business Account Set-Up: Log into your PayPal business account. Go to the Tools dropdown menu and select 'All Tools'. Choose Integrate API on the left ...

    • Integrating Quipu with Aspen & Koha

      Aspen supports Quipu eCARD (self-registration) and eRENEW (patron account renewal). First, decide whether your library would like to have Quipu's form display in Aspen or embed it on your website. Aspen setup If you want to keep the form on your ...

    • Single Sign-On Authentication Options for Koha

      Koha offers several options for using external authentication services to allow users to sign in. Basics about SSO For setting up any SSO there are a few things that will make the process proceed smoothly: Communication between the partner and their ...

    • Twilio Integration with Koha

      Some of our partners subscribe to Twilio for SMS messages and phone notifications from Koha. If you are a ByWater Solutions partner and have a Twilio account, we can help you set up the connection. Twilio SMS Twilio sends the SMS notices that Koha ...