<?xml version="1.0" encoding="UTF-8"?><rss version="2.0"
	xmlns:content="http://purl.org/rss/1.0/modules/content/"
	xmlns:wfw="http://wellformedweb.org/CommentAPI/"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:atom="http://www.w3.org/2005/Atom"
	xmlns:sy="http://purl.org/rss/1.0/modules/syndication/"
	xmlns:slash="http://purl.org/rss/1.0/modules/slash/"
	>

<channel>
	<title>Corentin Cailleaud, Author at Clever Cloud</title>
	<atom:link href="https://www.clever.cloud/blog/author/caillef/feed/" rel="self" type="application/rss+xml" />
	<link></link>
	<description>From Code to Product</description>
	<lastBuildDate>Thu, 24 May 2018 13:50:00 +0000</lastBuildDate>
	<language>en-GB</language>
	<sy:updatePeriod>
	hourly	</sy:updatePeriod>
	<sy:updateFrequency>
	1	</sy:updateFrequency>
	

<image>
	<url>https://cdn.clever-cloud.com/uploads/2023/03/cropped-cropped-favicon-32x32.png</url>
	<title>Corentin Cailleaud, Author at Clever Cloud</title>
	<link></link>
	<width>32</width>
	<height>32</height>
</image> 
	<item>
		<title>Mautic on Clever Cloud</title>
		<link>https://www.clever.cloud/blog/features/2018/05/24/deploying-mautic-on-clever-cloud/</link>
		
		<dc:creator><![CDATA[Corentin Cailleaud]]></dc:creator>
		<pubDate>Thu, 24 May 2018 13:50:00 +0000</pubDate>
				<category><![CDATA[Features]]></category>
		<category><![CDATA[feature]]></category>
		<category><![CDATA[PHP]]></category>
		<guid isPermaLink="false">https://www2.cleverapps.io/wp/blog/technology/2018/05/24/deploying-mautic-on-clever-cloud/</guid>

					<description><![CDATA[<p><img width="1400" height="540" src="https://cdn.clever-cloud.com/uploads/2021/08/mautic-1.png" class="attachment-post-thumbnail size-post-thumbnail wp-post-image" alt="mautic 1" decoding="async" fetchpriority="high" srcset="https://cdn.clever-cloud.com/uploads/2021/08/mautic-1.png 1400w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-300x116.png 300w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-1024x395.png 1024w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-768x296.png 768w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-1368x528.png 1368w" sizes="(max-width: 1400px) 100vw, 1400px" /></p><p>Changes about data privacy are rippling out worldwide, because of the new law from Europe: the GDPR.</p>
<p>Set to take effect on May 25th of this year, this new law restricts the data that companies can collect, and more specifically, how to store and use these data. So, before using any SaaS tool for marketing, sales or analytics, we have to take a step back, and think about the impact this new tool can have on your <a href="https://github.com/privacyradius/gdpr-checklist" title="External GitHub link ">GDPR data compliance checkist</a>. Open source and self-hosted tools like Mautic significantly reduce the complexity of your compliance checklist (they also have a <a href="https://www.mautic.org/blog/marketer/mautic-and-gdpr/" title="mautic post about GDPR">great post about it</a>).</p>
<p>Mautic provides free and open source marketing automation software available to everyone; free email marketing software, lead management software and more.</p>
<p>This post is about how you can deploy step by step your own Mautic server on Clever Cloud (within a Europe-only zone) using Git.</p>
<span id="more-2935"></span>

<h2 id="requirements">Requirements</h2>
<p>If you haven&#39;t done it yet, download the archive <a href="https://www.mautic.org/download">here</a> and unzip it in an empty directory.</p>
<p>Then, create a PHP application linked with a MySQL add-on from the <a href="https://console.clever-cloud.com">Clever Cloud Console</a> or directly from you terminal using the <a href="https://www.clever.cloud/developers/clever-tools/getting_started/">Clever Cloud CLI</a>:</p>
<pre><code class="language-bash">$ clever create --type php mautic-php --alias production
</code></pre>
<pre><code class="language-bash">$ # For MySQL, let&#39;s show available plans:
$ clever addon providers show mysql-addon
$ # For a matter of performance, let&#39;s create &#39;mautic-mysql&#39; add-on with the &#39;m&#39; plan
$ clever addon create mysql-addon --plan m mautic-mysql-M --link mautic-php
</code></pre>
<p>You also have to create 2 <a href="https://www.clever.cloud/developers/addons/fs_buckets">FS Bucket</a> add-ons that we will configure in the next part.</p>
<pre><code class="language-bash">$ clever addon create fs-bucket mautic-fs-media --link mautic-php
$ clever addon create fs-bucket mautic-fs-config --link mautic-php
</code></pre>
<h2 id="dynamic-contents">Dynamic contents</h2>
<p>In order to keep everything persisted between two deployments, we will use the two <a href="https://www.clever.cloud/developers/addons/fs_buckets">FS Bucket</a> add-ons to store files that will be modified during the installation.</p>
<p>You need to add two variables in your application&#39;s environment to link those FS Buckets with the corresponding directories.</p>
<p><strong>Note:</strong> The <code>fs_bucket_host</code> can be found in each FS Bucket dashboards.</p>
<pre><code class="language-bash">CC_FS_BUCKET=/media:&lt;fs_bucket_host_1&gt;
CC_FS_BUCKET_1=/app/config:&lt;fs_bucket_host_2&gt;
</code></pre>
<p>The next step is to upload the content of the <code>media</code> directory to the first FS Bucket and the content of the <code>app/config</code> directory to the second FS Bucket. You can use <a href="https://filezilla-project.org/">FileZilla</a> to upload those files.</p>
<p>Once everything is uploaded, delete the content of those directories (FS Bucket add-on has to be linked to an empty directory).</p>
<h2 id="crontab">Crontab</h2>
<p>One of the main features of Mautic is e-mail delivery. You can&#39;t use this feature if you haven&#39;t configured crontab.</p>
<p>Therefore, we will configure 3 crons to update segments and trigger campaigns by adding a script in the <code>cron-scripts</code> directory at the root of the main directory.</p>
<p><code>cron-scripts/mautic_cron.sh</code></p>
<pre><code class="language-bash">#! /usr/bin/env bash
source /home/bas/applicationrc
/usr/bin/php ${APP_HOME}/app/console $1
</code></pre>
<p>Then, we create a <code>clevercloud/cron.json</code> file containing the lines below to trigger the script:</p>
<pre><code class="language-json">[
  &quot;0,15,30,45 *  * * * sh $ROOT/cron-scripts/mautic_cron.sh mautic:segments:update&quot;,
  &quot;5,20,35,50 *  * * * sh $ROOT/cron-scripts/mautic_cron.sh mautic:campaigns:update&quot;,
  &quot;10,25,40,55 *  * * * sh $ROOT/cron-scripts/mautic_cron.sh mautic:campaigns:trigger&quot;
]
</code></pre>
<h3 id="going-further-with-crontab">Going further with crontab</h3>
<p>You might want to go further in your marketing automation and add new crons to trigger updates for social automation for example. The full list of crons is available <a href="https://www.mautic.org/docs/en/setup/cron_jobs.html">here</a>.</p>
<h2 id="deploying-mautic-on-clever-cloud">Deploying Mautic on Clever Cloud</h2>
<p>Now it&#39;s time to use Git to deploy it to Clever Cloud.</p>
<pre><code class="language-bash">$ git init
$ git add .
$ git commit -m &quot;Mautic init config&quot;

$ # if you have installed the Clever Cloud CLI
$ clever link &lt;APP_ID | APP_NAME&gt;
$ clever deploy

# else use a remote
$ git remote add clever &lt;REMOTE_URL&gt; # (available in the information of your app)
$ git push clever master
</code></pre>
<p>Wait for a few seconds, and your application should be running!</p>
<h2 id="configuration-screen">Configuration screen</h2>
<p>The configuration is pretty straightforward. Follow the instructions and fill it with MySQL&#39;s credentials which you can find in the add-on configuration screen of the web console of Clever Cloud.</p>
<p>You also have to setup the Mailer transport.</p>
<h2 id="what-can-i-do-now-">What can I do now ?</h2>
<p>After logging in, you can start configuring your marketing automations with the <a href="https://www.mautic.org/docs/en/index.html">Mautic Documentation</a>.</p>
<p>If you need help while deploying your own Mautic server on Clever Cloud, join the <a href="https://gitter.im/CleverCloud/home">Clever Cloud Gitter</a> and ask us any questions. Thanks for reading, and don&#39;t hesitate to reach our support if you need anything! ✌️</p>
]]></description>
										<content:encoded><![CDATA[<p><img width="1400" height="540" src="https://cdn.clever-cloud.com/uploads/2021/08/mautic-1.png" class="attachment-post-thumbnail size-post-thumbnail wp-post-image" alt="mautic 1" decoding="async" srcset="https://cdn.clever-cloud.com/uploads/2021/08/mautic-1.png 1400w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-300x116.png 300w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-1024x395.png 1024w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-768x296.png 768w, https://cdn.clever-cloud.com/uploads/2021/08/mautic-1-1368x528.png 1368w" sizes="(max-width: 1400px) 100vw, 1400px" /></p><p>Changes about data privacy are rippling out worldwide, because of the new law from Europe: the GDPR.</p>
<p>Set to take effect on May 25th of this year, this new law restricts the data that companies can collect, and more specifically, how to store and use these data. So, before using any SaaS tool for marketing, sales or analytics, we have to take a step back, and think about the impact this new tool can have on your <a href="https://github.com/privacyradius/gdpr-checklist" title="External GitHub link ">GDPR data compliance checkist</a>. Open source and self-hosted tools like Mautic significantly reduce the complexity of your compliance checklist (they also have a <a href="https://www.mautic.org/blog/marketer/mautic-and-gdpr/" title="mautic post about GDPR">great post about it</a>).</p>
<p>Mautic provides free and open source marketing automation software available to everyone; free email marketing software, lead management software and more.</p>
<p>This post is about how you can deploy step by step your own Mautic server on Clever Cloud (within a Europe-only zone) using Git.</p>
<span id="more-2935"></span>

<h2 id="requirements">Requirements</h2>
<p>If you haven&#39;t done it yet, download the archive <a href="https://www.mautic.org/download">here</a> and unzip it in an empty directory.</p>
<p>Then, create a PHP application linked with a MySQL add-on from the <a href="https://console.clever-cloud.com">Clever Cloud Console</a> or directly from you terminal using the <a href="https://www.clever.cloud/developers/clever-tools/getting_started/">Clever Cloud CLI</a>:</p>
<pre><code class="language-bash">$ clever create --type php mautic-php --alias production
</code></pre>
<pre><code class="language-bash">$ # For MySQL, let&#39;s show available plans:
$ clever addon providers show mysql-addon
$ # For a matter of performance, let&#39;s create &#39;mautic-mysql&#39; add-on with the &#39;m&#39; plan
$ clever addon create mysql-addon --plan m mautic-mysql-M --link mautic-php
</code></pre>
<p>You also have to create 2 <a href="https://www.clever.cloud/developers/addons/fs_buckets">FS Bucket</a> add-ons that we will configure in the next part.</p>
<pre><code class="language-bash">$ clever addon create fs-bucket mautic-fs-media --link mautic-php
$ clever addon create fs-bucket mautic-fs-config --link mautic-php
</code></pre>
<h2 id="dynamic-contents">Dynamic contents</h2>
<p>In order to keep everything persisted between two deployments, we will use the two <a href="https://www.clever.cloud/developers/addons/fs_buckets">FS Bucket</a> add-ons to store files that will be modified during the installation.</p>
<p>You need to add two variables in your application&#39;s environment to link those FS Buckets with the corresponding directories.</p>
<p><strong>Note:</strong> The <code>fs_bucket_host</code> can be found in each FS Bucket dashboards.</p>
<pre><code class="language-bash">CC_FS_BUCKET=/media:&lt;fs_bucket_host_1&gt;
CC_FS_BUCKET_1=/app/config:&lt;fs_bucket_host_2&gt;
</code></pre>
<p>The next step is to upload the content of the <code>media</code> directory to the first FS Bucket and the content of the <code>app/config</code> directory to the second FS Bucket. You can use <a href="https://filezilla-project.org/">FileZilla</a> to upload those files.</p>
<p>Once everything is uploaded, delete the content of those directories (FS Bucket add-on has to be linked to an empty directory).</p>
<h2 id="crontab">Crontab</h2>
<p>One of the main features of Mautic is e-mail delivery. You can&#39;t use this feature if you haven&#39;t configured crontab.</p>
<p>Therefore, we will configure 3 crons to update segments and trigger campaigns by adding a script in the <code>cron-scripts</code> directory at the root of the main directory.</p>
<p><code>cron-scripts/mautic_cron.sh</code></p>
<pre><code class="language-bash">#! /usr/bin/env bash
source /home/bas/applicationrc
/usr/bin/php ${APP_HOME}/app/console $1
</code></pre>
<p>Then, we create a <code>clevercloud/cron.json</code> file containing the lines below to trigger the script:</p>
<pre><code class="language-json">[
  &quot;0,15,30,45 *  * * * sh $ROOT/cron-scripts/mautic_cron.sh mautic:segments:update&quot;,
  &quot;5,20,35,50 *  * * * sh $ROOT/cron-scripts/mautic_cron.sh mautic:campaigns:update&quot;,
  &quot;10,25,40,55 *  * * * sh $ROOT/cron-scripts/mautic_cron.sh mautic:campaigns:trigger&quot;
]
</code></pre>
<h3 id="going-further-with-crontab">Going further with crontab</h3>
<p>You might want to go further in your marketing automation and add new crons to trigger updates for social automation for example. The full list of crons is available <a href="https://www.mautic.org/docs/en/setup/cron_jobs.html">here</a>.</p>
<h2 id="deploying-mautic-on-clever-cloud">Deploying Mautic on Clever Cloud</h2>
<p>Now it&#39;s time to use Git to deploy it to Clever Cloud.</p>
<pre><code class="language-bash">$ git init
$ git add .
$ git commit -m &quot;Mautic init config&quot;

$ # if you have installed the Clever Cloud CLI
$ clever link &lt;APP_ID | APP_NAME&gt;
$ clever deploy

# else use a remote
$ git remote add clever &lt;REMOTE_URL&gt; # (available in the information of your app)
$ git push clever master
</code></pre>
<p>Wait for a few seconds, and your application should be running!</p>
<h2 id="configuration-screen">Configuration screen</h2>
<p>The configuration is pretty straightforward. Follow the instructions and fill it with MySQL&#39;s credentials which you can find in the add-on configuration screen of the web console of Clever Cloud.</p>
<p>You also have to setup the Mailer transport.</p>
<h2 id="what-can-i-do-now-">What can I do now ?</h2>
<p>After logging in, you can start configuring your marketing automations with the <a href="https://www.mautic.org/docs/en/index.html">Mautic Documentation</a>.</p>
<p>If you need help while deploying your own Mautic server on Clever Cloud, join the <a href="https://gitter.im/CleverCloud/home">Clever Cloud Gitter</a> and ask us any questions. Thanks for reading, and don&#39;t hesitate to reach our support if you need anything! ✌️</p>
]]></content:encoded>
					
		
		
			</item>
		<item>
		<title>Deploying a Piwik Server on Clever Cloud</title>
		<link>https://www.clever.cloud/blog/features/2016/11/09/deploy-piwik-with-clever-cloud/</link>
		
		<dc:creator><![CDATA[Corentin Cailleaud]]></dc:creator>
		<pubDate>Wed, 09 Nov 2016 17:55:00 +0000</pubDate>
				<category><![CDATA[Features]]></category>
		<category><![CDATA[analytics]]></category>
		<category><![CDATA[PHP]]></category>
		<guid isPermaLink="false">https://www2.cleverapps.io/wp/blog/technology/2016/11/09/deploy-piwik-with-clever-cloud/</guid>

					<description><![CDATA[<p><img width="1400" height="540" src="https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1.png" class="attachment-post-thumbnail size-post-thumbnail wp-post-image" alt="piwik server 1" decoding="async" srcset="https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1.png 1400w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-300x116.png 300w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-1024x395.png 1024w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-768x296.png 768w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-1368x528.png 1368w" sizes="(max-width: 1400px) 100vw, 1400px" /></p><p>Those days, gathering data is a pretty important thing to improve your application. It can, indeed, help you <strong>optimize your website</strong> by knowing where your visitors are clicking. All those informations are collected thanks to analytics platforms such as <strong>Piwik</strong>.</p>
<span id="more-2876"></span>

<h3 id="what-is-piwik-">What is Piwik ?</h3>
<p><a href="https://piwik.org/">Piwik</a> is the <strong>leading open-source analytics platform</strong> that gives you, on top of good analytics, 100% data ownership and user privacy protection. You can know how many people visited a specific page and even set goals. For example, if you redirect your visitor to a thank you page if they buy your 10$ product, you can set a goal that says &quot;If the visitor comes on this page, I will earn 10$&quot;. Therefore, you can have an entiere overview of your profits. You can use <a href="http://demo.piwik.org/">this link</a> to access the Piwik demo and discover the graphical interface.</p>
<h3 id="how-can-i-run-my-piwik-server-">How can I run my Piwik server ?</h3>
<p>So you want to deploy a Piwik server using Clever Cloud. The Piwik server is a <strong>PHP application</strong>, therefore there are two ways to install it. The easiest one is explained down below, using SFTP but you can also install the server locally and push it with git. If you want to set it up fastly and easily, just follow those few steps and you will be able to get analytics from your application in a few minutes !</p>
<h3 id="three-simple-steps">Three simple steps</h3>
<p>First things first, create a <strong>PHP SFTP application</strong> in the Clever Cloud console and link it with a <strong>MySQL addon</strong>.</p>
<p>Then, unzip the Piwik file available <a href="https://piwik.org/download/">here</a> and upload the content of the directory <code>piwik</code> at the root of your FSBucket. You can use for example, <a href="https://filezilla-project.org/">FileZilla</a> to upload those files. Don&#39;t forget to add a <code>.user.ini</code> file with the line <code>always_populate_raw_post_data=-1</code> in order to install Piwik.</p>
<p>The final step is to deploy your application and start the installation by clicking on your application link. If you have any issue, you can check the <a href="https://piwik.org/docs/installation/#the-5-minut-piwik-installation">installation guide</a>. When you have to setup your MySQL database, click on your MySQL addon in the Clever Cloud console and fill the form with (left: field name in Piwik/right: field name in MySQL):</p>
<ul>
<li>Database server : <code>Host</code></li>
<li>Login : <code>User</code></li>
<li>Password : <code>Password</code></li>
<li>Database name : <code>Database</code></li>
</ul>
<p>And that&#39;s it ! Your Piwik server is now ready to give you informations about your traffic. Don&#39;t forget to add the JavaScript code on each page. You can start setting up your own goals as mentioned above. If you have a big amount of traffic, don&#39;t hesitate to check <a href="http://piwik.org/docs/optimize-how-to/">this page</a> that explains how you can optimize your Piwik server.</p>
<p>If you have not created your Clever Cloud account yet, you can sign up <a href="https://api.clever-cloud.com/v2/session/signup">here</a> and start creating your application.</p>
]]></description>
										<content:encoded><![CDATA[<p><img width="1400" height="540" src="https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1.png" class="attachment-post-thumbnail size-post-thumbnail wp-post-image" alt="piwik server 1" decoding="async" loading="lazy" srcset="https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1.png 1400w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-300x116.png 300w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-1024x395.png 1024w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-768x296.png 768w, https://cdn.clever-cloud.com/uploads/2021/08/piwik-server-1-1368x528.png 1368w" sizes="auto, (max-width: 1400px) 100vw, 1400px" /></p><p>Those days, gathering data is a pretty important thing to improve your application. It can, indeed, help you <strong>optimize your website</strong> by knowing where your visitors are clicking. All those informations are collected thanks to analytics platforms such as <strong>Piwik</strong>.</p>
<span id="more-2876"></span>

<h3 id="what-is-piwik-">What is Piwik ?</h3>
<p><a href="https://piwik.org/">Piwik</a> is the <strong>leading open-source analytics platform</strong> that gives you, on top of good analytics, 100% data ownership and user privacy protection. You can know how many people visited a specific page and even set goals. For example, if you redirect your visitor to a thank you page if they buy your 10$ product, you can set a goal that says &quot;If the visitor comes on this page, I will earn 10$&quot;. Therefore, you can have an entiere overview of your profits. You can use <a href="http://demo.piwik.org/">this link</a> to access the Piwik demo and discover the graphical interface.</p>
<h3 id="how-can-i-run-my-piwik-server-">How can I run my Piwik server ?</h3>
<p>So you want to deploy a Piwik server using Clever Cloud. The Piwik server is a <strong>PHP application</strong>, therefore there are two ways to install it. The easiest one is explained down below, using SFTP but you can also install the server locally and push it with git. If you want to set it up fastly and easily, just follow those few steps and you will be able to get analytics from your application in a few minutes !</p>
<h3 id="three-simple-steps">Three simple steps</h3>
<p>First things first, create a <strong>PHP SFTP application</strong> in the Clever Cloud console and link it with a <strong>MySQL addon</strong>.</p>
<p>Then, unzip the Piwik file available <a href="https://piwik.org/download/">here</a> and upload the content of the directory <code>piwik</code> at the root of your FSBucket. You can use for example, <a href="https://filezilla-project.org/">FileZilla</a> to upload those files. Don&#39;t forget to add a <code>.user.ini</code> file with the line <code>always_populate_raw_post_data=-1</code> in order to install Piwik.</p>
<p>The final step is to deploy your application and start the installation by clicking on your application link. If you have any issue, you can check the <a href="https://piwik.org/docs/installation/#the-5-minut-piwik-installation">installation guide</a>. When you have to setup your MySQL database, click on your MySQL addon in the Clever Cloud console and fill the form with (left: field name in Piwik/right: field name in MySQL):</p>
<ul>
<li>Database server : <code>Host</code></li>
<li>Login : <code>User</code></li>
<li>Password : <code>Password</code></li>
<li>Database name : <code>Database</code></li>
</ul>
<p>And that&#39;s it ! Your Piwik server is now ready to give you informations about your traffic. Don&#39;t forget to add the JavaScript code on each page. You can start setting up your own goals as mentioned above. If you have a big amount of traffic, don&#39;t hesitate to check <a href="http://piwik.org/docs/optimize-how-to/">this page</a> that explains how you can optimize your Piwik server.</p>
<p>If you have not created your Clever Cloud account yet, you can sign up <a href="https://api.clever-cloud.com/v2/session/signup">here</a> and start creating your application.</p>
]]></content:encoded>
					
		
		
			</item>
		<item>
		<title>Updating our API doc</title>
		<link>https://www.clever.cloud/blog/features/2016/09/13/update-api-documentation/</link>
		
		<dc:creator><![CDATA[Corentin Cailleaud]]></dc:creator>
		<pubDate>Tue, 13 Sep 2016 15:51:00 +0000</pubDate>
				<category><![CDATA[Features]]></category>
		<category><![CDATA[API]]></category>
		<category><![CDATA[feature]]></category>
		<guid isPermaLink="false">https://www2.cleverapps.io/wp/blog/technology/2016/09/13/update-api-documentation/</guid>

					<description><![CDATA[<p><img width="1400" height="540" src="https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1.jpg" class="attachment-post-thumbnail size-post-thumbnail wp-post-image" alt="swagger update 1" decoding="async" loading="lazy" srcset="https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1.jpg 1400w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-300x116.jpg 300w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-1024x395.jpg 1024w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-768x296.jpg 768w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-1368x528.jpg 1368w" sizes="auto, (max-width: 1400px) 100vw, 1400px" /></p><p>Hi there, I am Corentin Cailleaud, a second year student at Nantes. It has been already a month since I am in internship here at Clever Cloud. My first mission was to complete the API documentation and this job is now over. Let&#39;s have a look.</p>
<span id="more-2869"></span>

<p>The Clever Cloud API is a tool that allows you to manage your account and your products. In order to help you using this API, I have updated the documentation, available <a href="https://www.clever.cloud/developers/api/">here</a>. Most of endpoints are now delivered with input and output models. Let&#39;s see what it means and why using the API is now easier !</p>
<h2 id="how-is-defined-our-api-documentation-">How is defined our API documentation ?</h2>
<p>Our API documentation is defined by a <a href="http://swagger.io">Swagger</a> file. Swagger is the world&#39;s most popular framework for APIs. It helps us describing our API and it gives you a good interface to get started with this tool.</p>
<p>Let&#39;s take an example : you want to create a new application.</p>
<ul>
<li>First you have to find the endpoint in the list. You can use resource&#39;s name to find it easily. Here we want an endpoint about application so let&#39;s find &quot;POST /self/applications&quot; in the &quot;applications&quot; list.</li>
</ul>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/find_endpoint.png">
  </figure>
</center>

<ul>
<li>Then, you have to click on the endpoint to know the input model you have to give.</li>
</ul>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/new_endpoint_version.png">
  </figure>
</center>

<p>If you are logged in, you can click on the &quot;Try it out!&quot; button to try your request !</p>
<h3 id="restlet-studio-ftw">Restlet Studio FTW</h3>
<p>I used <a href="https://studio.restlet.com">Restlet Studio</a> to modify this file as it was easier than updating the Swagger file directly from a text editor. Indeed, Restlet Studio allows you to create representations with few clicks. That&#39;s a very cool tool, here is a link to their <a href="https://restlet.com/technical-resources/restlet-studio/guide">Getting Started</a>.</p>
<h3 id="why-this-update">Why this update</h3>
<p>Before this update, you could not know everything about an endpoint, there was kind of a fog of war. When you clicked on the endpoint, you could not know what to give in input.</p>
<h4 id="before">Before</h4>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/old_endpoint_version.png">
  </figure>
</center>

<p>Now, the weather is clear, all those informations are available ! You can even click on the model and it automatically goes in the box, where you can modify it.</p>
<h4 id="after">After</h4>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/new_endpoint_version.png">
  </figure>
</center>

<p>The goal of this update is to be able to generate API client whenever the API is updated thanks to <a href="http://swagger.io/swagger-codegen/">swagger-codegen</a>. This tool can generate, from a Swagger definition, API client in different languages using different libraries. When this feature is available, your clients will be automatically updated when a new version of the API will be released.</p>
]]></description>
										<content:encoded><![CDATA[<p><img width="1400" height="540" src="https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1.jpg" class="attachment-post-thumbnail size-post-thumbnail wp-post-image" alt="swagger update 1" decoding="async" loading="lazy" srcset="https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1.jpg 1400w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-300x116.jpg 300w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-1024x395.jpg 1024w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-768x296.jpg 768w, https://cdn.clever-cloud.com/uploads/2021/08/swagger-update-1-1368x528.jpg 1368w" sizes="auto, (max-width: 1400px) 100vw, 1400px" /></p><p>Hi there, I am Corentin Cailleaud, a second year student at Nantes. It has been already a month since I am in internship here at Clever Cloud. My first mission was to complete the API documentation and this job is now over. Let&#39;s have a look.</p>
<span id="more-2869"></span>

<p>The Clever Cloud API is a tool that allows you to manage your account and your products. In order to help you using this API, I have updated the documentation, available <a href="https://www.clever.cloud/developers/api/">here</a>. Most of endpoints are now delivered with input and output models. Let&#39;s see what it means and why using the API is now easier !</p>
<h2 id="how-is-defined-our-api-documentation-">How is defined our API documentation ?</h2>
<p>Our API documentation is defined by a <a href="http://swagger.io">Swagger</a> file. Swagger is the world&#39;s most popular framework for APIs. It helps us describing our API and it gives you a good interface to get started with this tool.</p>
<p>Let&#39;s take an example : you want to create a new application.</p>
<ul>
<li>First you have to find the endpoint in the list. You can use resource&#39;s name to find it easily. Here we want an endpoint about application so let&#39;s find &quot;POST /self/applications&quot; in the &quot;applications&quot; list.</li>
</ul>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/find_endpoint.png">
  </figure>
</center>

<ul>
<li>Then, you have to click on the endpoint to know the input model you have to give.</li>
</ul>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/new_endpoint_version.png">
  </figure>
</center>

<p>If you are logged in, you can click on the &quot;Try it out!&quot; button to try your request !</p>
<h3 id="restlet-studio-ftw">Restlet Studio FTW</h3>
<p>I used <a href="https://studio.restlet.com">Restlet Studio</a> to modify this file as it was easier than updating the Swagger file directly from a text editor. Indeed, Restlet Studio allows you to create representations with few clicks. That&#39;s a very cool tool, here is a link to their <a href="https://restlet.com/technical-resources/restlet-studio/guide">Getting Started</a>.</p>
<h3 id="why-this-update">Why this update</h3>
<p>Before this update, you could not know everything about an endpoint, there was kind of a fog of war. When you clicked on the endpoint, you could not know what to give in input.</p>
<h4 id="before">Before</h4>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/old_endpoint_version.png">
  </figure>
</center>

<p>Now, the weather is clear, all those informations are available ! You can even click on the model and it automatically goes in the box, where you can modify it.</p>
<h4 id="after">After</h4>
<center>
  <figure>
    <img style="width:600px" src="https://www2.cleverapps.io/app/uploads/2021/08/new_endpoint_version.png">
  </figure>
</center>

<p>The goal of this update is to be able to generate API client whenever the API is updated thanks to <a href="http://swagger.io/swagger-codegen/">swagger-codegen</a>. This tool can generate, from a Swagger definition, API client in different languages using different libraries. When this feature is available, your clients will be automatically updated when a new version of the API will be released.</p>
]]></content:encoded>
					
		
		
			</item>
	</channel>
</rss>
