{% extends 'base.html.twig' %}

{% block title %}api Snap-GT{% endblock %}
{% block stylesheet %}

{% endblock %}
{% block body %}
<div class="doc-wrapper">
    <h1>SnapGT API ✅</h1>
    <p>documentation V0.0.1</p>
    <h2>Make REST API calls</h2>
    <p>    In REST API calls, include the URL to the API service for the environment:</p>
    <pre class="code">https://api.snap-gt.fr/</pre>
    <p>Also, include your access token to prove your identity and access protected resources.</p>
    <pre class='code'>https://api.snap-gt.fr/customer/xxxxxxxxx/</pre>
    <p>You can also download the <a href="https://api.snap-gt.fr/products/getcsv">SnapGT_product-list</a> csv file.<p></p><hr>
    <h3><strong>GET</strong> families</h3>
    <p>Retrieves the collection of Family resources. </p><pre class='code'>https://api.snap-gt.fr/customer/xxxxxxxxx/families</pre>
    <div><span>Response 200</span><span>: Family collection response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "families": [
    {
      "id": "int",
      "name": "string",
      "libelleFR": "string",
      "libelleNL": "string",
      "libelleEN": "string"
    },
    {
      "...": "..."
    }
  ]
}</code>
    </pre>

    <h3><strong>GET</strong> family</h3>
    <p>Retrieves a Family resource.</p><pre class='code'>https://api.snap-gt.fr/customer/xxxxxxxxx/families/id_family</pre>
    <div><span>Response 200</span><span>: Family resource response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
    "id": "int",
    "name": "string",
    "libelleFR": "string",
    "libelleNL": "string",
    "libelleEN": "string"
}</code>
    </pre>
<hr>
    
    <h3><strong>GET</strong> subfamilies</h3>
    <p>Retrieves the collection of SubFamily resources. </p><pre class='code'>https://api.snap-gt.fr/customer/xxxxxxxxx/families/id_family/subfamilies</pre>
    <div><span>Response 200</span><span>: SubFamily collection response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "subFamilies": [],
  "subfamilies": [
    {
      "id": "int",
      "name": "String",
      "libelleFR": "String",
      "libelleNL": "String",
      "libelleEN": "String"
    },
    {
        "...": "..."
    }

  ]
}</code>
    </pre>
<hr>

    <h3><strong>GET</strong> subfamilies</h3>
    <p>Retrieves a SubFamily resource. </p><pre class='code'>https://api.snap-gt.fr/customer/{customer_id}/families/{id}/subfamilies/{sub_id}</pre>
    <div><span>Response 200</span><span>: SubFamily resource response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
    "id": "int",
    "name": "string",
    "libelleFR": "string",
    "libelleNL": "string",
    "libelleEN": "string"
}</code>
</pre>
<hr>
    <h3><strong>GET</strong> products</h3>
    <p>Retrieves Product resources. </p><pre class='code'>https://api.snap-gt.fr/customer/{customer_id}/products"</pre>
    <div><span>Response 200</span><span>: Product collection response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "products": [],
  "subfamilies": [
    {
      "id": "int",
      "name": "string",
      "libelleFR": "string",
      "libelleNL": "string",
      "libelleEN": "string",
      "attribut": "string",
      "categorie": "string",
      "secteur": "string",
      "type": "string",
      "sous_type": "string",
      "status": "string",
      "famille": "string",
      "sous_famille": "string"
    },
    {
        "...": "..."
    }
    ]
}</code>
</pre>
<hr>

    <h3><strong>GET</strong> products by family</h3>
    <p>Retrieves Product resources by family. </p><pre class='code'>https://api.snap-gt.fr/customer/{customer_id}/products/families/{family_id}"</pre>
    <div><span>Response 200</span><span>: Product collection response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "products": [],
  "products": [
    {
      "id": "int",
      "name": "string",
      "libelleFR": "string",
      "libelleNL": "string",
      "libelleEN": "string",
      "attribut": "string",
      "categorie": "string",
      "secteur": "string",
      "type": "string",
      "sous_type": "string",
      "status": "string",
      "famille": "string",
      "sous_famille": "string"
    },
    {
      "...": "..."
    }
    ]
}</code>
</pre>
<hr>


    <h3><strong>GET</strong> products by subfamily</h3>
    <p>Retrieves Product resources by subfamily. </p><pre class='code'>https://api.snap-gt.fr/customer/{customer_id}/products/subfamilies/{subfamily_id}"</pre>
    <div><span>Response 200</span><span>: Product collection response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "products": [],
  "products": [
    {
      "id": "int",
      "name": "string",
      "libelleFR": "string",
      "libelleNL": "string",
      "libelleEN": "string",
      "attribut": "string",
      "categorie": "string",
      "secteur": "string",
      "type": "string",
      "sous_type": "string",
      "status": "string",
      "famille": "string",
      "sous_famille": "string"
    },
    {
      "...": "..."
    }
    ]
}</code>
</pre>
<hr>

    <h3><strong>GET</strong> productSizes by product</h3>
    <p>Retrieves ProductSize resources by product. </p><pre class='code'>https://api.snap-gt.fr/customer/{customer_id}/products/{product_id}/articles"</pre>
    <div><span>Response 200</span><span>: ProductSize collection response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "productSizes": [],
  "productSizes": [
    {
      "id": "int",
      "name": "string",
      "size": "string",
      "ean": "string",
      "gtin": "string",
      "salePrice": "float",
      "purchasePrice": "float",
      "currency": "string",
      "poids_net": "float",
      "poids_brut": "float"
    },
    {
      "...": "..."
    }
    ]
}</code>
</pre>
<hr>

    <h3><strong>GET</strong> productSizes by ean</h3>
    <p>Retrieves a ProductSize resources by ean. </p><pre class="code">https://api.snap-gt.fr/customer/{customer_id}/products/articles/{ean}"</pre>
    <div><span>Response 200</span><span>: ProductSize resource response :</span></div>
    <pre class='code'><label>Json</label><code class="json-color">
{
  "productSizes": [],
  "productSizes": [
    {
      "id": "int",
      "name": "string",
      "size": "string",
      "ean": "string",
      "gtin": "string",
      "salePrice": "float",
      "purchasePrice": "float",
      "currency": "string",
      "poids_net": "float",
      "poids_brut": "float"
    }
    ]
}</code>
</pre>
</div>
{% endblock %}