Skip to content

Commit cc59979

Browse files
timbkbasictimbkbasic
committed
Bumped version to 0.7.1. Added more documentation.
1 parent a17ee66 commit cc59979

17 files changed

+691
-5
lines changed

‎docs/apidocs/authentication.html‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Authentication
32+
</div>
33+
34+
<h1>Authentication</h1>
35+
<p>
36+
The MyCloud API uses
37+
<a href="https://jwt.io/">JSON Web Tokens (JWT)</a>
38+
for authetication. This stateless authentication protocol
39+
is becoming a popular standard for API's for many good
40+
technical reasons. Here at MyCloud, we chose JWT because
41+
it is simple to implement, requires very little overhead,
42+
has many libraries available in almost every popular
43+
programming language, and eliminates the need for state
44+
(such as sessions and cookies), which means that it can
45+
scale better.
46+
</p>
47+
<p>
48+
If you are using the PHP SDK, you do not need to worry
49+
about JWT. All of the authentication is handled for you
50+
by the SDK. All you need to do is configure your API
51+
keys, and you are all set to beging using the API.
52+
</p>
53+
</div>
54+
</body>
55+
</html>

‎docs/apidocs/connection.html‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Connection
32+
</div>
33+
34+
<h1>Connection</h1>
35+
<p>
36+
The MyCloud API is a RESTful API implemented using the HTTP protocol.
37+
This means that all connections to the API are the same as any other
38+
HTTP connection, which is the protocol used by every web browser to
39+
access a website. The advantage of the HTTP protocol is that it is
40+
a well established standard that is supported by every modern
41+
programming language in use today.
42+
</p>
43+
</div>
44+
</body>
45+
</html>

‎docs/apidocs/index.html‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a>&nbsp;&gt;&nbsp;API&nbsp;Documentation
30+
</div>
31+
32+
<h1>API Overview</h1>
33+
<ul>
34+
<li><a href="overview.html">Overview</a></li>
35+
<li><a href="connection.html">Connection</a></li>
36+
<li><a href="authentication.html">Authentication</a></li>
37+
<li><a href="protocol.html">Protocol</a></li>
38+
<li><a href="overview-php.html">PHP SDK Overview</a></li>
39+
</ul>
40+
41+
<h1>API Models</h1>
42+
<ul>
43+
<li><a href="model-customer.html">Customer</a></li>
44+
<li><a href="model-delivery-mode.html">Delivery Mode</a></li>
45+
<li><a href="model-order.html">Order</a></li>
46+
<li><a href="model-order-item.html">Order Item</a></li>
47+
<li><a href="model-product.html">Product</a></li>
48+
<li><a href="model-product-category.html">Product Category</a></li>
49+
<li><a href="model-shop.html">Shop</a></li>
50+
</ul>
51+
</div>
52+
</body>
53+
</html>

‎docs/apidocs/model-customer.html‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Customer
32+
</div>
33+
34+
<h1>Customer Model</h1>
35+
<p>
36+
The Customer model represents a customer that is defined for your shop.
37+
</p>
38+
</div>
39+
</body>
40+
</html>

‎docs/apidocs/model-delivery-mode.html‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Delivery&nbsp;Mode
32+
</div>
33+
34+
<h1>Delivery Mode Model</h1>
35+
<p>
36+
The Delivery Mode model represents a mode of delivery that is defined
37+
for your shop.
38+
</p>
39+
</div>
40+
</body>
41+
</html>

‎docs/apidocs/model-order-item.html‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Order&nbsp;Item
32+
</div>
33+
34+
<h1>Order Item Model</h1>
35+
<p>
36+
The Order Item model represents a product that is an item on
37+
an order for your shop. For each product that is part of an
38+
order, there will be an order item. In other words, order items
39+
<em>connect</em> products to orders. Furthermore, an order item
40+
also defines the quantity of the product being ordered, as well
41+
as the actual price the product is being sold for on that order.
42+
</p>
43+
</div>
44+
</body>
45+
</html>

‎docs/apidocs/model-order.html‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Order
32+
</div>
33+
34+
<h1>Order Model</h1>
35+
<p>
36+
The Order model represents an order placed with your shop.
37+
</p>
38+
</div>
39+
</body>
40+
</html>

‎docs/apidocs/model-product-category.html‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API Documentation</title>
4+
<link rel="icon" type="image/png" sizes="96x96" href="../img/favicon-96x96.png">
5+
<link rel="icon" type="image/png" sizes="72x72" href="../img/favicon-72x72.png">
6+
<link rel="icon" type="image/png" sizes="32x32" href="../img/favicon-32x32.png">
7+
<link rel="icon" type="image/png" sizes="16x16" href="../img/favicon-16x16.png">
8+
<link href="../css/mycloud.css" rel="stylesheet">
9+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,300i|Roboto+Condensed:400,700" rel="stylesheet">
10+
<script src="https://use.fontawesome.com/e353b17481.js"></script>
11+
</head>
12+
<body class="mycloud-github api-docs">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="index.html"><img src="../img/logo_white.png" alt="MyCloud Logo"></a>
17+
<h1>MyCloud API PHP SDK</h1>
18+
<div class="buttons">
19+
<a href="https://github.com/devmycloud/MyCloudAPI-SDK-PHP"><span class="fa fa-github"></span> GutHub</a>
20+
<a href="../index.html">Home</a>
21+
<a href="../readme.html">README</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.1.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="bread-crumb">
29+
<a href="../index.html">Home</a
30+
>&nbsp;&gt; <a href="index.html">API&nbsp;Documentation</a
31+
>&nbsp;&gt; Product&nbsp;Category
32+
</div>
33+
34+
<h1>Product Category Model</h1>
35+
<p>
36+
The Product Category model represents a category that you have
37+
defined to <em>group</em> products together.
38+
</p>
39+
</div>
40+
</body>
41+
</html>

0 commit comments

Comments
 (0)