vugrima/docs/APIKEY.html at master · HeardLibrary/vugrima · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<!DOCTYPE html>
<html lang="en-US"><head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">

<!-- Begin Jekyll SEO tag v2.5.0 -->
<title>Requesting your API key | grima</title>
<meta name="generator" content="Jekyll v3.8.5">
<meta property="og:title" content="Requesting your API key">
<meta property="og:locale" content="en_US">
<meta name="description" content="grima - whispering into alma’s ear with APIs">
<meta property="og:description" content="grima - whispering into alma’s ear with APIs">
<meta property="og:site_name" content="grima">
<script type="application/ld+json">
{"description":"grima - whispering into alma’s ear with APIs","@type":"WebPage","url":"/docs/APIKEY.html","headline":"Requesting your API key","@context":"http://schema.org"}</script>
<!-- End Jekyll SEO tag -->

    <link rel="stylesheet" href="../assets/css/style.css?v=0be73a336ce259bae00bdeaea26da30311963da5">
    <script src="../assets/js/scale.fix.js"></script>
    <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
    <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
  </head>
  <body>
    <div class="wrapper">
      <header>
        <h1 class="header"><a href="..">grima</a></h1>
        <p class="header">grima - whispering into alma's ear with APIs</p>

        <ul>

          <li><a class="buttons github" href="https://github.com/zemkat/grima">View On GitHub</a></li>
        </ul>


          <p class="header">This project is maintained by <a class="header name" href="https://github.com/zemkat">zemkat</a></p>


      </header>

      <section>
        <h1 id="requesting-your-api-key">Requesting your API key</h1>

<p>Grima should have its own API key with appropriate permissions.
To set up an API key, first login to
<a href="https://developers.exlibrisgroup.com/">Ex Libris Developer Network</a>.
If you do not yet have an account on Developer Network, you can
create one for free. You may need to contact your system administrator
to give your account access to your Alma database.</p>

<p>Once you are logged in to the Developer Network, click the <strong>Build</strong> area:</p>

<p><img src="images/APIKEY-header.png" alt="Screen shot of Developer Network with Build circled"></p>

<p>In the left box, click <strong>Manage Keys</strong>:</p>

<p><img src="images/APIKEY-manage.png" alt="Screen shot of Dashboard with applications circled"></p>

<p>Scroll to the bottom past any existing keys, and click the
<strong>Add API Key</strong> button:</p>

<p><img src="images/APIKEY-addkey.png" alt="Screen shot of Dashboard with applications circled"></p>

<p>Fill out this <strong>form</strong> with information like this. To add permissions for new
API areas, click the <strong>Add Permission</strong> button, and for each one, select
the Area, the Environment (production or sandbox), and the permissions you
want (Read/write or Read-only). Click the Save button to continue.</p>

<p><img src="images/APIKEY-editkey.png" alt="Screen shot of new application form"></p>

<p>The application should now be created, and will display on the applications
list. To access the API key, click the eye symbol to make it visible, and
then click the Copy button to get it into your clipboard.</p>

<p><img src="images/APIKEY-copy.png" alt="Screen shot of grima on Application list"></p>

<p>The API key is a long string like:</p>

<p><code class="highlighter-rouge">l7xx9e21b7b5s3a4ie66xh69pcbx78cfx978</code></p>

<p>and is what Grima will ask for when you set up your institution.</p>

      </section>

      <footer>
        <p><small>Hosted on <a href="https://pages.github.com">GitHub Pages</a> using the Dinky theme</small></p>
      </footer>
    </div>
    <!--[if !IE]><script>fixScale(document);</script><![endif]-->


</body></html>