forked from michaelkirkpatrick/catalog-beer
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-usage.php
87 lines (66 loc) · 4.39 KB
/
api-usage.php
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
<?php
// Initialize
$guest = true;
include_once $_SERVER["DOCUMENT_ROOT"] . '/classes/initialize.php';
// HTML Head
$htmlHead = new htmlHead('API Usage');
echo $htmlHead->html;
?>
<style>
h2 {
margin-top: 4rem;
}
h3 {
margin-top: 3rem;
}
h4 {
margin-top: 2rem;
color:#4b555e;
}
</style>
<body>
<?php
// Navbar
echo $nav->navbar('');
?>
<div class="container">
<div class="row">
<div class="col-md-2"></div>
<div class="col-md-8">
<h1>API Usage</h1>
<p class="lead">The Catalog.beer Application Programming Interface (API) has been designed to make it easy for you to access information about Brewers and beers and tasting rooms.</p>
<p>When it comes to using the API, anyone is welcome to use it; all you have to do is <a href="/signup">create an account</a> and verify your email address. If you have questions about how to use the API, refer to our <a href="/api-docs">API Documentation</a> or <a href="/contact">drop us a line</a>.</p>
<h2>Basic Rules</h2>
<hr>
<h3>Creative Commons License</h3>
<p>All the content that is accessible via the API is licensed under a <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International license (CC BY 4.0)</a>. This excludes a Brewery’s rights in its name, brand(s), and trademarks. What does that mean?</p>
<h4>You are free to</h4>
<ul>
<li><strong>Share</strong> — copy and redistribute the material in any medium or format</li>
<li><strong>Adapt</strong> — remix, transform, and build upon the material
for any purpose, even commercially.</li>
</ul>
<h4>What’s required of you?</h4>
<p>You must give appropriate credit to Catalog.beer, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.</p>
<p>For example, if you reproduce the description for <a href="/brewer/375289f8-6cc5-2d38-3ce7-73ab50b8dff4">Long Beach Beer Lab</a>, a brewer, you should include an attribution like this:</p>
<p>“<a href="/brewer/375289f8-6cc5-2d38-3ce7-73ab50b8dff4">Long Beach Beer Lab</a>” by <a href="https://catalog.beer">Catalog.beer</a> is licensed under <a href="https://creativecommons.org/licenses/by/4.0/">CC BY 4.0</a></p>
<h3>Use the API responsibly</h3>
<p>We’re new, so there aren’t any hard and fast rules or people who have burned us in the past that have required us to make some rules. A few guidelines and notes:</p>
<ul>
<li>We may delete old accounts (more than a year old) without notice if we see that you haven’t used Catalog.beer in more than a year.</li>
<li>If you have questions, <a href="/contact">ask them</a>. We respond quickly to messages sent via our website.</li>
</ul>
<h2>Pricing</h2>
<hr>
<p class="lead"><strong>tl;dr - It’s free.</strong></p>
<p class="lead">If you make more than 1,000 API requests per month, at some point in the future we’ll charge you $0.50 per additional 1,000 requests. Right now we’re only monitoring usage.</p>
<p>Catalog.beer was created to enable anyone to access brewery and beer information. To that end, our mission is to give anyone who wants it API access so they can poke around and contribute to the database. If you’re someone who enjoys beer and wants to build themselves a little application using the Catalog.beer API, we want it to be free for you to use. To that end, everyone with a Catalog.beer API key has 1,000 requests per month that are free.</p>
<p>If you’re someone who’s making more than 1,000 API request per month, odds are you’re leveraging our database as part of another application that people are using. That’s great! We want you to do that! At some point, we will start charging you for the number of API requests you make over 1,000 each month. Right now we’re only monitoring usage and not charging for it.</p>
<p>How much will it cost? $0.50 per additional 1,000 requests. We think that’s the cheapest rate out there for access to beer data. Our goal is cover our operating costs. If you have questions about pricing or just want to talk about it, <a href="/contact">send us a message</a>; we’d love to hear from you.</p>
</div>
<div class="col-md-2"></div>
</div>
</div>
<?php echo $nav->footer(); ?>
</body>
</html>