Skip to content

Commit

Permalink
Add files
Browse files Browse the repository at this point in the history
  • Loading branch information
@louisaxel-ambroise
louisaxel-ambroise committed Oct 15, 2021
1 parent dcd1a76 commit a75469b
Show file tree
Hide file tree
Showing 3 changed files with 197 additions and 6 deletions.
89 changes: 89 additions & 0 deletions css/style.css
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
*{
color:#444;
font-family: calibri;
}

body{
margin:0 auto;
max-width:960px;
}

h1{
font-size:300%;
}

menu{
height:40px;
border-bottom:1px solid #EEE;
}
menu a {
display:inline-block;
width:80px;
margin:0 10px;
height:25px;
line-height:25px;
margin-top:8px;
text-decoration:none;
color:#888;
}
menu a:hover{
color:#111;
}

section{
background:#FAFEFA;
border-radius:4px;
padding:10px 20px 30px 20px;
margin-bottom:50px;
}
section a{
color:#005282;
}

p{
text-align:justify;
}

input{
height:30px;
display:block;
margin:20px;
padding-left:10px;
font-size:16px;
width:280px;
}

input[type=submit]{
margin-left:140px;
width:160px;
padding-left:0px;
background:#33C3F0;
border: #33C3F0;
color:#FFF;
border-radius:4px;
font-weight:600;
letter-spacing: .1rem;
text-transform: uppercase;
cursor: pointer;
}

pre{
margin:20px;
padding:12px;
background:#444;
color:#EEE;
font-weight: 500;
font-family: consolas;
font-size:85%;
width:80%;
}

code{
font-family: consolas;
font-size:80%;
background:#444;
color:#EEE;
padding:0 5px;
line-height:20px;
display:inline-block;
}
51 changes: 45 additions & 6 deletions index.html
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,46 @@
<!DOCTYPE html>
<html>
<body>
<h1>Hello World</h1>
<p>I'm hosted with GitHub Pages.</p>
</body>
</html>
<head>
<link rel="stylesheet" href="css/style.css" media="all" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="charset" content="UTF-8" />
<title>FasT&amp;T - EPCIS repository</title>
</head>
<body>
<menu>
<a href="index.html">Home</a>
<a href="sandbox.html">Sandbox</a>
</menu>

<h1>FasT&amp;T - EPCIS repository</h1>

<section id="introduction">
<h2>Introduction</h2>
<p>FasTnT EPCIS is an implementation of the GS1 EPCIS 1.2 specification in .NET.</p>
<p></p>
</section>

<section id="setup">
<h2>Setup</h2>

<h3>Prerequisites:</h3>
<ul>
<li>SQL Server 2016 or +</li>
<li>.NET 5 SDK</li>
</ul>

<h3>Steps:</h3>
<ol>
<li><a href="https://github.com/FasTnT/epcis-ef-core/archive/refs/heads/main.zip">Download</a> the source code or <a href="https://github.com/FasTnT/epcis-ef-core.git">clone</a> the repository on GitHub;</li>
<li>Start the repository with the command <code>$ dotnet run -p FasTnT.Host\FasTnT.Host.csproj --urls "http://localhost:5102/" --connectionStrings:FasTnT.Database "{your connectionstring}"</code></li>
</ol>

<p>That's it! The database should be created automatically and you should be able to use the endpoints to capture or query events.</p>
</section>

<section id="sandbox">
<h2>Sandbox</h2>
<p>FasT&amp;T EPCIS repository is deployed on azure and accessible to the public for testing purpose. You can have more details on the <a href="sandbox.html">sandbox</a> page.</p>
<p>The repository is hosted on Microsoft Azure platform.</p>
</section>
</body>
</html>
63 changes: 63 additions & 0 deletions sandbox.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<html>
<head>
<link rel="stylesheet" href="css/style.css" media="all" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="charset" content="UTF-8" />
<title>FasT&amp;T - EPCIS Sandbox</title>
</head>
<body>
<menu>
<a href="index.html">Home</a>
<a href="sandbox.html">Sandbox</a>
</menu>

<h1>FasT&amp;T - EPCIS Sandbox</h1>

<section id="setup">
<h2>Introduction</h2>
<p>The Sandbox is a full EPCIS repository that allows you to use and test your EPCIS capture/queries. It's free and doesn't need any registeration or setup, so start to use it right now!</p>
<p>The base URL of this sandbox is <a href="https://fastnt-dev-api.azurewebsites.net/">https://fastnt-dev-api.azurewebsites.net/</a></p>
</section>

<section id="howto">
<h2>How to use</h2>
<p>A <a href="https://www.github.com/fastnt/epcis-ef-core/...">Postman collection</a> and a <a href="https://www.github.com/fastnt/epcis-ef-core/...">SoapUI project</a> can be found on the GitHub repository.</p>

<h3>Security</h3>
<p>Every request <i>must</i> include a Basic Authorization header. If the username specified is not found in the database, it will be created with the specified password. If the username already exists and the password doesn't match, or if the header is empty or malformed, the API will return a <code>401 - Unauthorized</code> response.</p>

<h3>Capture events</h3>
<pre>POST https://fastnt-dev-api.azurewebsites.net/v1_2/capture
Authorization: Basic username:password
Content-Type:text/xml

&lt;epcis:EPCISDocument
xmlns:epcis="urn:epcglobal:epcis:xsd:1"
schemaVersion="1.2"
creationDate="2018-06-12T06:31:32Z"&gt;
...
&lt;/epcis:EPCISDocument&gt;
</pre>
<h3>Perform Queries</h3>
<pre>POST https://fastnt-dev-api.azurewebsites.net/v1_2/query.svc
Authorization: Basic username:password
Content-Type:application/xml

&lt;soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:urn="urn:epcglobal:epcis-query:xsd:1"&gt;
&lt;soapenv:Body&gt;
...
&lt;/soapenv:Body&gt;
&lt;/soapenv:Envelope&gt;
</pre>
</section>

<section id="restrictions">
<h2>Restrictions</h2>
<p>As this EPCIS server is publicly available, the results will only contain the events that were captured by the exact same username/password values.</p>
<p>There is no guarantee on the duration the data will be kept on the server. Automatic as well as manual cleanup might occur without any warning.</p>
<p><strong>Note:</strong> it means in no case that the data is secured. Anyone that makes a request with the same authentication will see the data you send. You must not send any confidential or secret data to this server.</p>
</section>
</body>
</html>

0 comments on commit a75469b

Please sign in to comment.