Breweries

API Reference

<p>All data within the platform is private by default. In order to access the Beer API data, you must authenticate using the user name and password associated to your account.</p><br>

Authentication

<p>There are two types of tokens that can be used to authenticate within Beer API.</p><br><p>Temporary Token (JWT) are returned by the login endpoint. These tokens have a relatively short expiration time, and are thus the most secure option to use. The tokens are returned with a refresh_token that can be used to retrieve a new access token via the refresh endpoint.</p><br><p>Static Tokens can be set for each platform user, and never expire. They are less secure, but quite useful for server-to-server communication.</p><br><p>Once you have your access token, there are two ways to pass it to the API, via the access_token query parameter, or in the request's Authorization Header.</p><br><h5>Query Parameter</h5><br><p><code>?access_token={token}</code></p><br><h5>Authorization Parameter</h5><br><p><code>Authorization: Bearer {token}</code></p><br>

Access Tokens

<p>Retrieve a temporary access token and refresh token.</p><br><figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="3bcd8400-c2bc-469e-bff5-ac4ff04086c9-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>email</td><td>1</td><td>string</td><td>The email associated to your account.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>password</td><td>1</td><td>string</td><td>The password associated to your account.</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure><br>

Login

<p>Retrieve a new access token using a refresh token.</p><br><figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="ac190f71-4614-42f5-9355-aab47a1a6fe0-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>refresh_token</td><td>1</td><td>string</td><td>The refresh token to use.&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure><br>

Refresh

<p>Invalidate the refresh token, thus destroying the user's session.</p><br><p><code>refresh_token</code></p><br><p>The refresh token to invalidate.&nbsp;</p><br>

Logout

<p>Retrieve a list of all breweries in the database.</p><br><h6>Returns</h6><br><p>An array of all breweries in the database.</p><br>

GET Breweries

<p>Retrieve a brewery by ID.</p><br><p>A brewery, if a valid brewery ID was provided.</p><br>

Get Brewery by ID

<p>Is your favorite new brewery missing? Submit a new brewery for review by our team.</p><br><figure class="table ck-widget ck-widget_with-selection-handle" contenteditable="false"><table class="request-editor-view" style="border-width:0;" id="8f571bd8-05eb-4319-9025-701ba942467b-request"><tbody><tr><td>Title</td><td>Required?</td><td>Type</td><td>Description</td><td>Min Length</td><td>Max Length</td></tr><tr><td>name</td><td>1</td><td>string</td><td>The name of the brewery.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>address</td><td>1</td><td>string</td><td>The address of the brewery.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>city</td><td>1</td><td>string</td><td>The city in which the brewery is located.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>type</td><td>1</td><td>int</td><td>The type of brewery. See Types API.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>state</td><td>0</td><td>string</td><td>The state in which the brewery is located.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>county_province</td><td>0</td><td>string</td><td>The county or province in which the brewery is located (if applicable).</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>postal_code</td><td>0</td><td>string</td><td>The postal code of the brewery.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>country</td><td>0</td><td>string</td><td>The country in which the brewery is located.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>phone</td><td>0</td><td>string</td><td>The phone number of the brewery.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>website_url</td><td>0</td><td>string</td><td>The website of the brewery.</td><td>&nbsp;</td><td>&nbsp;</td></tr><tr><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td><td>&nbsp;</td></tr></tbody></table></figure><br>

Add A Brewery

Brewery Types

<p>Retrieve a list of all brewery types in the database.</p><br><h6>Returns</h6><br><p>An array of all brewery types in the database.</p><br>

Get List of Types

<p>Retrieve a brewery type.</p><br><h6>Returns</h6><br><p>A brewery type, if a valid brewery ID was provided.</p><br>

Get Type

Errors

Beer API

<p class="slate-p"><p class="slate-p">All data within the platform is private by default. In order to access the Beer API data, you must authenticate using the user name and password associated to your account.</p><p class="slate-p"><br /></p></p>

<p class="slate-p"><p class="slate-p">Retrieve a list of all brewery types in the database.</p><p class="slate-p"><br /></p><div class="slate-h6">Returns</div><p class="slate-p"><br /></p><p class="slate-p">An array of all brewery types in the database.</p><p class="slate-p"><br /></p></p>

Content-Type

data

<p class="slate-p"><p class="slate-p">Retrieve a brewery type.</p><p class="slate-p"><br /></p><div class="slate-h6">Returns</div><p class="slate-p"><br /></p><p class="slate-p">A brewery type, if a valid brewery ID was provided.</p><p class="slate-p"><br /></p></p>

<p class="slate-p"><p class="slate-p">Error handling.</p><p class="slate-p"><br /></p></p>

Sections