update with jeans input on authentication

docs/index.html

@@ -43,26 +43,56 @@
          <div class=content>
 
                <h1 id="introduction">Introduction</h1>
-<p>Welcome to the Clear Payments API - Powered by Clear Treasury. With international payments a daily necessity for many, we have developed our online payments platform that dramatically streamlines the process.</p>
+<blockquote>
+<p>Base [ENV] url variables</p>
+</blockquote>
+<pre class="highlight "><code>sandbox: api-test<span class="hljs-selector-class">.cleartreasury</span><span class="hljs-selector-class">.co</span><span class="hljs-selector-class">.uk</span>/api
+live: api<span class="hljs-selector-class">.cleartreasury</span><span class="hljs-selector-class">.co</span><span class="hljs-selector-class">.uk</span>/api</code></pre><p>Welcome to the Clear Payments API - Powered by Clear Treasury. With international payments a daily necessity for many, we have developed our online payments platform that dramatically streamlines the process.</p>
 <p>We have designed the Clear Payments API to integrate directly into your process, product or software.</p>
 <h1 id="authentication">Authentication</h1>
 <blockquote>
-<p>To authorize, use this code:</p>
+<p>use this code:</p>
 </blockquote>
 <pre class="highlight bash"><code><span class="hljs-comment"># With shell, you can just pass the correct header with each request</span>
-curl <span class="hljs-string">"api_endpoint_here"</span>
-  -H <span class="hljs-string">"Authorization: --yourAuthKey--"</span></code></pre><pre class="highlight javascript"><code><span class="hljs-keyword">const</span> kittn = <span class="hljs-built_in">require</span>(<span class="hljs-string">'kittn'</span>);
+curl -X POST \
+  http://[ENV].cleartreasury.co.uk/api/token \
+  -H <span class="hljs-string">'Content-Type: application/x-www-form-urlencoded'</span> \
+  -d <span class="hljs-string">'login=--YOUR LOGIN--&amp;password=--YOUR PASSWORD--'</span></code></pre><pre class="highlight javascript"><code><span class="hljs-keyword">var</span> settings = {
+  <span class="hljs-string">"async"</span>: <span class="hljs-literal">true</span>,
+  <span class="hljs-string">"crossDomain"</span>: <span class="hljs-literal">true</span>,
+  <span class="hljs-string">"url"</span>: <span class="hljs-string">"http://[ENV].cleartreasury.co.uk/api/token"</span>,
+  <span class="hljs-string">"method"</span>: <span class="hljs-string">"POST"</span>,
+  <span class="hljs-string">"headers"</span>: {
+    <span class="hljs-string">"Content-Type"</span>: <span class="hljs-string">"application/x-www-form-urlencoded"</span>,
+   },
+  <span class="hljs-string">"data"</span>: {
+    <span class="hljs-string">"login"</span>: <span class="hljs-string">"--YOUR LOGIN--"</span>,
+    <span class="hljs-string">"password"</span>: <span class="hljs-string">"--YOUR PASSWORD--"</span>
+  }
+}
 
-<span class="hljs-keyword">let</span> api = kittn.authorize(<span class="hljs-string">'--yourAuthKey--'</span>);</code></pre><blockquote>
-<p>Make sure to replace <code>--yourAuthKey--</code> with your API key.</p>
+$.ajax(settings).done(<span class="hljs-function"><span class="hljs-keyword">function</span> (<span class="hljs-params">response</span>) </span>{
+  <span class="hljs-built_in">console</span>.log(response);
+});</code></pre><blockquote>
+<p>Clear Payments expects the API Token to be included in all API requests to the server in a header that looks like the following:</p>
 </blockquote>
-<p>Clear Payments uses API keys to allow access to the API. You can register a new API key at our <a href="https://payments.cleartreasury.co.uk">developer portal</a>.</p>
-<p>Clear Payments expects for the API key to be included in all API requests to the server in a header that looks like the following:</p>
-<p><code>Authorization: --yourAuthKey--</code></p>
+<pre class="highlight "><code>curl -X POST <span class="hljs-string">\</span>
+  <span class="hljs-string">'[ENV].cleartreasury.co.uk/--ENDPOINT--'</span> <span class="hljs-string">\</span>
+  -H <span class="hljs-string">'Authorization: Bearer --YOUR TOKEN--'</span> <span class="hljs-string">\</span> 
+</code></pre><p>Clear API uses a token that needs to be set in the header of each call.</p>
+<p>To generate your token you can use /api/Token endpoint</p>
+<aside class=notice>
+You must replace <code>--YOUR TOKEN--</code> with your personal API key.
+</aside>
+<aside class=notice>
+You must replace <code>--YOUR LOGIN--</code> with your Login.
+</aside>
 <aside class=notice>
-You must replace <code>--yourAuthKey--</code> with your personal API key.
+You must replace <code>--YOUR PASSWORD--</code> with your Password. 
 </aside>
 
+<p>This Token is valid for 6 months.</p>
+
 
                <h1 id="bookquote">Bookquote</h1>
 <blockquote>
@@ -87,7 +117,7 @@ <h1 id="bookquote">Bookquote</h1>
   <span class="hljs-attr">"OurSWIFTCode"</span>: <span class="hljs-string">"string"</span>,
   <span class="hljs-attr">"Message"</span>: <span class="hljs-string">"string"</span>
 }</code></pre><h3 id="http-request">HTTP Request</h3>
-<p><code>POST /api/BookQuote/BookQuote</code> </p>
+<p><code>POST /BookQuote/BookQuote</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -168,7 +198,7 @@ <h2 id="get">GET</h2>
     <span class="hljs-attr">"exportedDate"</span>: <span class="hljs-string">"2019-10-17T11:27:23.691Z"</span>
   }
 ]</code></pre><h3 id="http-request-1">HTTP Request</h3>
-<p><code>GET /api/PaymentInstruction/GetValues</code> </p>
+<p><code>GET /PaymentInstruction/GetValues</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -210,7 +240,7 @@ <h2 id="get">GET</h2>
 </tbody></table>
 <h2 id="post">POST</h2>
 <h3 id="http-request-2">HTTP Request</h3>
-<p><code>POST /api/PaymentInstruction/PostValue</code> </p>
+<p><code>POST /PaymentInstruction/PostValue</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -246,7 +276,7 @@ <h3 id="http-request-2">HTTP Request</h3>
 <h1 id="quote">Quote</h1>
 <h2 id="post-1">POST</h2>
 <h3 id="http-request-3">HTTP Request</h3>
-<p><code>POST /api/Quote/PostValue</code> </p>
+<p><code>POST /Quote/PostValue</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -316,7 +346,7 @@ <h3 id="http-request-3">HTTP Request</h3>
 </tbody></table>
 <h2 id="get-1">GET</h2>
 <h3 id="http-request-4">HTTP Request</h3>
-<p><code>GET /api/Quote/GetValue</code> </p>
+<p><code>GET /Quote/GetValue</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -367,7 +397,7 @@ <h2 id="calculatequote">calculatequote</h2>
   <span class="hljs-attr">"Message"</span>: <span class="hljs-string">"string"</span>,
   <span class="hljs-attr">"Status"</span>: <span class="hljs-literal">true</span>
 }</code></pre><h3 id="http-request-5">HTTP Request</h3>
-<p><code>POST /api/Quote/CalculateQuote</code> </p>
+<p><code>POST /Quote/CalculateQuote</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -416,7 +446,7 @@ <h2 id="get-2">GET</h2>
     <span class="hljs-attr">"Balance"</span>: <span class="hljs-number">0</span>
   }
 ]</code></pre><h3 id="http-request-6">HTTP Request</h3>
-<p><code>GET /api/Statement/GetValues</code> </p>
+<p><code>GET /Statement/GetValues</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -511,7 +541,7 @@ <h2 id="get-3">GET</h2>
     <span class="hljs-attr">"pin_check_count"</span>: <span class="hljs-number">0</span>
   }
 ]</code></pre><h3 id="http-request-7">HTTP Request</h3>
-<p><code>GET /api/Template/GetValues</code> </p>
+<p><code>GET /Template/GetValues</code> </p>
 <p><strong>Responses</strong></p>
 <table>
 <thead>
@@ -528,7 +558,7 @@ <h2 id="get-3">GET</h2>
 <h1 id="token">Token</h1>
 <h2 id="post-2">POST</h2>
 <h3 id="http-request-8">HTTP Request</h3>
-<p><code>POST /api/Token/PostValues</code> </p>
+<p><code>POST /Token/PostValues</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -583,7 +613,7 @@ <h2 id="get-4">GET</h2>
     <span class="hljs-attr">"Beneficiary"</span>: <span class="hljs-string">"string"</span>
   }
 ]</code></pre><h3 id="http-request-9">HTTP Request</h3>
-<p><code>GET /api/Trade/GetValues</code> </p>
+<p><code>GET /Trade/GetValues</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -634,7 +664,7 @@ <h2 id="filters">Filters</h2>
     <span class="hljs-attr">"Description"</span>: <span class="hljs-string">"string"</span>
   }
 ]</code></pre><h3 id="http-request-10">HTTP Request</h3>
-<p><code>GET /api/webhooks/filters</code> </p>
+<p><code>GET /webhooks/filters</code> </p>
 <p><strong>Responses</strong></p>
 <table>
 <thead>
@@ -666,7 +696,7 @@ <h2 id="registrations">Registrations</h2>
     <span class="hljs-attr">"Properties"</span>: {}
   }
 ]</code></pre><h3 id="http-request-11">HTTP Request</h3>
-<p><code>GET /api/webhooks/registrations</code> </p>
+<p><code>GET /webhooks/registrations</code> </p>
 <p><strong>Responses</strong></p>
 <table>
 <thead>
@@ -681,7 +711,7 @@ <h2 id="registrations">Registrations</h2>
 </tr>
 </tbody></table>
 <h3 id="http-request-12">HTTP Request</h3>
-<p><code>POST /api/webhooks/registrations</code> </p>
+<p><code>POST /webhooks/registrations</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -715,7 +745,7 @@ <h3 id="http-request-12">HTTP Request</h3>
 </tr>
 </tbody></table>
 <h3 id="http-request-13">HTTP Request</h3>
-<p><code>DELETE /api/webhooks/registrations</code> </p>
+<p><code>DELETE /webhooks/registrations</code> </p>
 <p><strong>Responses</strong></p>
 <table>
 <thead>
@@ -732,7 +762,7 @@ <h3 id="http-request-13">HTTP Request</h3>
 <h2 id="registrationsid">Registrations/{id}</h2>
 <h3 id="get-5">GET</h3>
 <h3 id="http-request-14">HTTP Request</h3>
-<p><code>GET /api/webhooks/registrations/{id}</code> </p>
+<p><code>GET /webhooks/registrations/{id}</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -767,7 +797,7 @@ <h3 id="http-request-14">HTTP Request</h3>
 </tbody></table>
 <h3 id="put">PUT</h3>
 <h3 id="http-request-15">HTTP Request</h3>
-<p><code>PUT /api/webhooks/registrations/{id}</code> </p>
+<p><code>PUT /webhooks/registrations/{id}</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>
@@ -809,7 +839,7 @@ <h3 id="http-request-15">HTTP Request</h3>
 </tbody></table>
 <h3 id="delete">DELETE</h3>
 <h3 id="http-request-16">HTTP Request</h3>
-<p><code>DELETE /api/webhooks/registrations/{id}</code> </p>
+<p><code>DELETE /webhooks/registrations/{id}</code> </p>
 <p><strong>Parameters</strong></p>
 <table>
 <thead>

source/includes/FXOps.md

@@ -24,7 +24,7 @@
 ```
 
 ### HTTP Request 
-`POST /api/BookQuote/BookQuote` 
+`POST /BookQuote/BookQuote` 
 
 **Parameters**
 
@@ -79,7 +79,7 @@
 ```
 
 ### HTTP Request 
-`GET /api/PaymentInstruction/GetValues` 
+`GET /PaymentInstruction/GetValues` 
 
 **Parameters**
 
@@ -97,7 +97,7 @@
 ## POST 
 
 ### HTTP Request 
-`POST /api/PaymentInstruction/PostValue` 
+`POST /PaymentInstruction/PostValue` 
 
 **Parameters**
 
@@ -115,7 +115,7 @@
 ## POST 
 
 ### HTTP Request 
-`POST /api/Quote/PostValue` 
+`POST /Quote/PostValue` 
 
 **Parameters**
 
@@ -137,7 +137,7 @@
 ## GET 
 
 ### HTTP Request 
-`GET /api/Quote/GetValue` 
+`GET /Quote/GetValue` 
 
 **Parameters**
 
@@ -172,7 +172,7 @@
 ```
 
 ### HTTP Request 
-`POST /api/Quote/CalculateQuote` 
+`POST /Quote/CalculateQuote` 
 
 **Parameters**
 
@@ -207,7 +207,7 @@
 ```
 
 ### HTTP Request 
-`GET /api/Statement/GetValues` 
+`GET /Statement/GetValues` 
 
 **Parameters**
 
@@ -276,7 +276,7 @@
 ```
 
 ### HTTP Request 
-`GET /api/Template/GetValues` 
+`GET /Template/GetValues` 
 
 **Responses**
 
@@ -288,7 +288,7 @@
 ## POST 
 
 ### HTTP Request 
-`POST /api/Token/PostValues` 
+`POST /Token/PostValues` 
 
 **Parameters**
 
@@ -329,7 +329,7 @@
 ```
 
 ### HTTP Request 
-`GET /api/Trade/GetValues` 
+`GET /Trade/GetValues` 
 
 **Parameters**
 
@@ -358,7 +358,7 @@
 ```
 
 ### HTTP Request 
-`GET /api/webhooks/filters` 
+`GET /webhooks/filters` 
 
 **Responses**
 
@@ -387,7 +387,7 @@
 ```
 
 ### HTTP Request 
-`GET /api/webhooks/registrations` 
+`GET /webhooks/registrations` 
 
 **Responses**
 
@@ -397,7 +397,7 @@
 
 
 ### HTTP Request 
-`POST /api/webhooks/registrations` 
+`POST /webhooks/registrations` 
 
 **Parameters**
 
@@ -413,7 +413,7 @@
 
 
 ### HTTP Request 
-`DELETE /api/webhooks/registrations` 
+`DELETE /webhooks/registrations` 
 
 **Responses**
 
@@ -425,7 +425,7 @@
 ### GET 
 
 ### HTTP Request 
-`GET /api/webhooks/registrations/{id}` 
+`GET /webhooks/registrations/{id}` 
 
 **Parameters**
 
@@ -442,7 +442,7 @@
 ### PUT 
 
 ### HTTP Request 
-`PUT /api/webhooks/registrations/{id}` 
+`PUT /webhooks/registrations/{id}` 
 
 **Parameters**
 
@@ -460,7 +460,7 @@
 ### DELETE 
 
 ### HTTP Request 
-`DELETE /api/webhooks/registrations/{id}` 
+`DELETE /webhooks/registrations/{id}` 
 
 **Parameters**