Skip to content

Commit d93137e

Browse files
timbkbasictimbkbasic
committed
First version of github website generated using Hugo
1 parent 1846c73 commit d93137e

File tree

29 files changed

+2634
-1
lines changed

29 files changed

+2634
-1
lines changed

‎docs/apidocs/authentication/index.html‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API PHP SDK</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 home-page">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="../../"><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="../../readme/">README</a>
21+
<a href="../../apidocs/">Documentation</a>
22+
<a href="../../downloads/mycloud-api-sdk-php-0.7.4.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="page-content">
29+
<div class="bread-crumb">
30+
<a href="../../index.html">Home</a
31+
>&nbsp;&gt; <a href="../../apidocs/index.html">API&nbsp;Documentation</a
32+
>&nbsp;&gt; Authentication
33+
</div>
34+
35+
<h1>Authentication</h1>
36+
<p>
37+
The MyCloud API uses
38+
<a href="https://jwt.io/">JSON Web Tokens (JWT)</a>
39+
for authetication. This stateless authentication protocol
40+
is becoming a popular standard for API's for many good
41+
technical reasons. Here at MyCloud, we chose JWT because
42+
it is straighforward to implement, requires very little
43+
overhead, has libraries available in almost every popular
44+
programming language, and eliminates the need for state
45+
(such as sessions and cookies), which means that it can
46+
scale better.
47+
</p>
48+
<p>
49+
If you are using the PHP SDK, you do not need to worry
50+
about JWT. All of the authentication is handled for you
51+
by the SDK. All you need to do is configure your API
52+
keys, and you are all set to beging using the API.
53+
</p>
54+
<p>
55+
The JWT authentication is <em>token based</em>, which
56+
means that the API never sends user logins or passwords
57+
within the protocol. Your account is provided with an
58+
apiKey and a secretKey, which are exchanged in the
59+
protocol. Tokens expire after a reasonble period
60+
(currently 8 hours), after which they must be refreshed.
61+
This allows MyCloud to expire or invalidate keys that
62+
are known to be compromised, without needing to modify
63+
your account login credentials. If your tokens are
64+
ever compromised, we simply issue new tokens for your
65+
account. You can then login to get the new keys, add
66+
them to your configuration, and continue working with
67+
the API.
68+
</p>
69+
<p>
70+
When you make requests with the API, you will set
71+
the 'Authentication' header, with a 'Bearer '
72+
specification that includes your JWT token. This
73+
token is then verified against the token list on the
74+
server to authenticate your request.
75+
</p>
76+
<p>
77+
If you do not have a token, or the token you are using
78+
has expired, then you will need to request a new token.
79+
The API exposes a POST request named '/gettoken' to get
80+
a new token to continue using the API. The request takes
81+
two parameters: apikey, secretKey. With this request,
82+
a JWT token will be returned to you, which you will then
83+
used in the 'Authentication' header for every other API
84+
request that you make.
85+
</p>
86+
<p>
87+
If you are using the PHP SDK, you never need to worry
88+
about any of the authentication protocols. You will
89+
configure your API keys in the sdk_config.ini
90+
configuration file used by your program, and the SDK
91+
will handle everything for you.
92+
</p>
93+
</div>
94+
95+
</div>
96+
97+
</body>
98+
</html>

‎docs/apidocs/connection/index.html‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API PHP SDK</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 home-page">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="../../"><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="../../readme/">README</a>
21+
<a href="../../apidocs/">Documentation</a>
22+
<a href="../../downloads/mycloud-api-sdk-php-0.7.4.zip">Binary Distribution</a>
23+
</div>
24+
</div>
25+
</div>
26+
27+
<div class="page-content">
28+
<div class="page-content">
29+
<div class="bread-crumb">
30+
<a href="../../index.html">Home</a
31+
>&nbsp;&gt; <a href="../../apidocs/index.html">API&nbsp;Documentation</a
32+
>&nbsp;&gt; Connection
33+
</div>
34+
35+
<h1>Connection</h1>
36+
<p>
37+
The MyCloud API is a RESTful API implemented using the HTTP protocol.
38+
This means that all connections to the API are the same as any other
39+
HTTP connection, which is the protocol used by every web browser to
40+
access a website. The advantage of the HTTP protocol is that it is
41+
a well established standard that is supported by every modern
42+
programming language in use today.
43+
</p>
44+
</div>
45+
46+
</div>
47+
48+
</body>
49+
</html>

‎docs/apidocs/index.html‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<html>
2+
<head>
3+
<title>MyCloud API PHP SDK</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 home-page">
13+
14+
<div class="page-heading">
15+
<div class="heading">
16+
<a href="../"><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="../readme/">README</a>
21+
<a href="../apidocs/">Documentation</a>
22+
<a href="../downloads/mycloud-api-sdk-php-0.7.4.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">Overview</a></li>
35+
<li><a href="connection">Connection</a></li>
36+
<li><a href="authentication">Authentication</a></li>
37+
<li><a href="overview-api">API Overview</a></li>
38+
<li><a href="overview-protocol">API Protocol</a></li>
39+
<li><a href="overview-php">PHP SDK Overview</a></li>
40+
</ul>
41+
42+
<h1>API Models</h1>
43+
<ul>
44+
<li><a href="models/customer">Customer</a></li>
45+
<li><a href="models/delivery-mode">Delivery Mode</a></li>
46+
<li><a href="models/order">Order</a></li>
47+
<li><a href="models/order-item">Order Item</a></li>
48+
<li><a href="models/product">Product</a></li>
49+
<li><a href="models/product-category">Product Category</a></li>
50+
<li><a href="models/shop">Shop</a></li>
51+
</ul>
52+
53+
</div>
54+
55+
</body>
56+
</html>

‎docs/apidocs/index.xml‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
2+
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
3+
<channel>
4+
<title>Apidocs on MyCloudFulfillment API PHP SDK</title>
5+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/</link>
6+
<description>Recent content in Apidocs on MyCloudFulfillment API PHP SDK</description>
7+
<generator>Hugo -- gohugo.io</generator>
8+
<language>en-us</language>
9+
10+
<atom:link href="https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/index.xml" rel="self" type="application/rss+xml" />
11+
12+
13+
<item>
14+
<title></title>
15+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/authentication/</link>
16+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
17+
18+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/authentication/</guid>
19+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Authentication Authentication The MyCloud API uses JSON Web Tokens (JWT) for authetication. This stateless authentication protocol is becoming a popular standard for API&#39;s for many good technical reasons. Here at MyCloud, we chose JWT because it is straighforward to implement, requires very little overhead, has libraries available in almost every popular programming language, and eliminates the need for state (such as sessions and cookies), which means that it can scale better.</description>
20+
</item>
21+
22+
<item>
23+
<title></title>
24+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/connection/</link>
25+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
26+
27+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/connection/</guid>
28+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Connection Connection The MyCloud API is a RESTful API implemented using the HTTP protocol. This means that all connections to the API are the same as any other HTTP connection, which is the protocol used by every web browser to access a website. The advantage of the HTTP protocol is that it is a well established standard that is supported by every modern programming language in use today.</description>
29+
</item>
30+
31+
<item>
32+
<title></title>
33+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/</link>
34+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
35+
36+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/</guid>
37+
<description>Home&amp;nbsp;&amp;gt;&amp;nbsp;API&amp;nbsp;Documentation API Overview Overview Connection Authentication API Overview API Protocol PHP SDK Overview API Models Customer Delivery Mode Order Order Item Product Product Category Shop </description>
38+
</item>
39+
40+
<item>
41+
<title></title>
42+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/customer/</link>
43+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
44+
45+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/customer/</guid>
46+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Customer Customer Model The Customer model represents a customer that is defined for your shop. Model Attributes id Unique numeric ID of the customer. Methods: integer getId() object setId( integer ) address The address of the customer. Methods: string getAddress() object setAddress( string ) code The code that the shop assigned to the customer. Methods: string getCode() object setCode( string ) email The e-mail address of the customer.</description>
47+
</item>
48+
49+
<item>
50+
<title></title>
51+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/delivery-mode/</link>
52+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
53+
54+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/delivery-mode/</guid>
55+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Delivery&amp;nbsp;Mode Delivery Mode Model The Delivery Mode model represents a mode of delivery that is defined for your shop. Model Attributes id Unique numeric ID of the delivery mode. Methods: integer getId() object setId( integer ) code The code that the shop assigned to the delivery mode. Methods: string getCode() object setCode( string ) name The name of the delivery mode.</description>
56+
</item>
57+
58+
<item>
59+
<title></title>
60+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/order-item/</link>
61+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
62+
63+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/order-item/</guid>
64+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Order&amp;nbsp;Item Order Item Model The Order Item model represents a product that is an item on an order for your shop. For each product that is part of an order, there will be an order item. In other words, order items connect products to orders. Furthermore, an order item also defines the quantity of the product being ordered, as well as the actual price the product is being sold for on that order.</description>
65+
</item>
66+
67+
<item>
68+
<title></title>
69+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/order/</link>
70+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
71+
72+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/order/</guid>
73+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Order Order Model The Order model represents an order placed with your shop. Orders consist of OrderItems, which are the Products that are attached to the order. An order can have a Customer attached to it, but this is not required. And order must have a DeliveryMode attached to it to select the method of shipment. The payment attributes are provided for the customer to indicate to the shop when and how payment was made so the shop can verify payment.</description>
74+
</item>
75+
76+
<item>
77+
<title></title>
78+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/product-category/</link>
79+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
80+
81+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/product-category/</guid>
82+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Product&amp;nbsp;Category Product Category Model The Product Category model represents a category that you have defined to group products together. Model Attributes id Unique numeric ID of the category. Methods: integer getId() object setId( integer ) code The code assigned by the shop for this category. Methods: string getCode() object setCode( string ) name The name of the category. Methods: string getName() object setName( string ) API Calls array ProductCategory::all() Get all product categories defined by your shop.</description>
83+
</item>
84+
85+
<item>
86+
<title></title>
87+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/product/</link>
88+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
89+
90+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/product/</guid>
91+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Product Product Model The Product model represents a product that your shop offers for sale. Model Attributes id Unique numeric ID of the product. Methods: integer getId() object setId( integer ) sku The SKU number of this product. Methods: string getSku() object setSku( string ) name The name of the product. Methods: string getName() object setName( string ) description The description of the product.</description>
92+
</item>
93+
94+
<item>
95+
<title></title>
96+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/shop/</link>
97+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
98+
99+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/models/shop/</guid>
100+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Shop Shop Model [read-only] The Shop model represents your shop. Note that this model is read-only. You can retrieve your Shop&#39;s model to access the information assigned to your shop, but the API does not provide any means for updating the Shop, or to create a new one. Model Attributes id Unique numeric ID of the shop. Methods: integer getId() code The code assigned to the shop by MyCloud.</description>
101+
</item>
102+
103+
<item>
104+
<title></title>
105+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview-api/</link>
106+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
107+
108+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview-api/</guid>
109+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; API&amp;nbsp;Overview API Overview The MyCloud API is a RESTful API. It is built on top of the HTTP protocol to implement communications with the API server. API Requests Client API requests send their data to the API server using the multipart/form-data specification defined by RFC7578, which is the same standard that web browsers use to submit form data when you submit an HTML &amp;lt;FORM&amp;gt; using the &#39;multipart/form-data&#39; enctype.</description>
110+
</item>
111+
112+
<item>
113+
<title></title>
114+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview-php/</link>
115+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
116+
117+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview-php/</guid>
118+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; PHP&amp;nbsp;SDK&amp;nbsp;Overview PHP SDK Overview The MyCloud API PHP SDK provides a complete PHP implementation of the client side the API. With the PHP SDK, you do not need to worry about any of the low level details of programming with the API. Connectivity, authentication, model objects, logging, and other supporting code is all provided for you. When working with the PHP SDK, you will work primarily with the API model objects.</description>
119+
</item>
120+
121+
<item>
122+
<title></title>
123+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview-protocol/</link>
124+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
125+
126+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview-protocol/</guid>
127+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Protocol Protocol The MyCloud API is a RESTful API implemented using the HTTP protocol. Over the HTTP protocol, a communication protocol is utilized to exchange the data necessary to fulfill any API request. The protocol uses two separate standards to implement the data exchange: Upstream: multipart/form-data Downstream: JSON Upstream The upstream data is the data sent from the API client to the API server.</description>
128+
</item>
129+
130+
<item>
131+
<title></title>
132+
<link>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview/</link>
133+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
134+
135+
<guid>https://devmycloud.github.io/MyCloudAPI-SDK-PHP/apidocs/overview/</guid>
136+
<description>Home&amp;nbsp;&amp;gt; API&amp;nbsp;Documentation&amp;nbsp;&amp;gt; Overview API Overview The MyCloud API is a RESTful API providing access to your MyCloud shop and the data associated with your shop. The current release of the API does not implement access to every element of your shop. It is designedprimarily to facilitate managing your customer, products and orders. Future releases of the API will continue to add more functionality. The API is implemented using standard HTTP connectivity and standard HTTP protocols.</description>
137+
</item>
138+
139+
</channel>
140+
</rss>

0 commit comments

Comments
 (0)