-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathchrome_postman.html
36 lines (21 loc) · 3.76 KB
/
chrome_postman.html
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
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Loopline Systems API</title><link rel="stylesheet" href="css/bootstrap-3.1.1.min.css"><link rel="stylesheet" href="css/font-awesome-4.0.3.min.css"><link rel="stylesheet" href="css/styles.css"><link rel="shortcut icon" href="http://cdn.loopline-systems.com/favicon.ico"><link rel="apple-touch-icon-precomposed" sizes="144x144" href="http://cdn.loopline-systems.com/lls-logo-144.png"></head><body><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i> Back to top</a><div class="container"><div class="row"><div class="col-md-3"><nav class="static"><a href="index.html"><img src="img/lls-logo.png" class="logo"></a><div id="static-pages" class="list-group"><a href="index.html" class="list-group-item heading">Loopline Systems API</a><a href="chrome_postman.html" class="list-group-item">Sandboxing with Postman</a><a href="error_responses.html" class="list-group-item">Error Responses</a><a href="integrations.html" class="list-group-item">Integrations</a><a href="index.html" class="list-group-item">REST API</a></div></nav><nav id="nav" class="hidden-sm hidden-xs affix nav dynamic"></nav></div><div id="content" class="col-md-8"><div><header><div class="page-header"><h1 id="top">Loopline Systems API Documentation</h1></div></header></div><h2>Sandboxing with Postman</h2>
<p>Postman is an extension for Chrome which makes it easy to create and send HTTP requests to a server. You can modify the HTTP method, headers and parameters.</p>
<p>First, install the Postman extension from the <a href="https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop">Chrome Webstore</a>.</p>
<p>You will need to 2 things then, the collection itself and an environment set up.</p>
<h3>Import the collection</h3>
<p>You can either download the collection <a href="res/Loopline-Systems-API.json.postman_collection">here</a> and import it to Postman
or import the collection directly. Paste the link into the "Download from link" section.</p>
<p><code>https://www.getpostman.com/collections/46cf79b02048e743c443</code></p>
<p><img alt="Download from link" src="img/download-from-link.png"/></p>
<h3>Import the environment file</h3>
<p>Download the <a href="res/Loopline-Systems-API.postman_environment">environment file</a> and add it to Postman.
<img alt="Manage Environment" src="img/manage-environments.png"/></p>
<p>Add your <code>loopline_client</code> value and <code>api_key</code>. You will get both from within the admin area in Loopline.</p>
<p> <img alt="Adjust Environment" src="img/add-environment-vars.png"/></p>
<p>You can also create the environment by yourself.
Because the collection uses placeholders you need to create an environment with three values:</p>
<ul><li>loopline_client: identifies your client (inside Loopline go to: Admin / API and integrations)</li><li>api_key: authenticates your client (inside Loopline go to: Admin / API and integrations)</li><li>host: the api endpoint, https://api.loopline-systems.com</li></ul>
<p>If you set up the values correctly, you should have access to the provided requests.</p><hr /></div></div></div><p id="footer" style="text-align: center;" class="text-muted">Generated with <a href="https://apiblueprint.org/" target="_blank" class="aglio">API Blueprint</a> and <a href="https://github.com/danielgtaylor/aglio" target="_blank" class="aglio">Aglio</a> and <a href="http://www.loopline-systems.com" target="_blank" class="aglio">© 2020 made with <span no-class="❤" class="heart">❤︎</span> in berlin</a></p></body><script src="js/jquery-1.11.0.min.js"></script><script src="js/bootstrap-3.1.1.min.js"></script><script src="js/api-doc.js"></script><script>(function() {
$('table').addClass('table');
}).call(this);
</script></html>