api.html

---
layout: api
title: API
byline: Offisiellt REST API for Nasjonal Turbase
class: api
---

<p>Denne siden beskriver resursene som til sammen bygger opp det offisielle APIet
for Nasjonal Turbase v1-beta. Hvis du her noen problemer eller andre
forespørsler ikke nøl med å ta kontakt.</p>

<h2>API-miljøer</h2>

<p>Nasjonal Turbase har to API-miljøer <code>api</code> or <code>dev</code>.

<div class="table-responsive">
  <table class="table table-bordered">
    <thead>
      <tr>
        <th>Miljø</th>
        <th>Hostname</th>
        <th>Beskrivelse</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><code>api</code></td>
        <td>api.nasjonalturbase.no</td>
        <td>Produksjonsmiljø - brukes mot sluttbrukere</td>
      </tr>
      <tr>
        <td><code>dev</code></td>
        <td>dev.nasjonalturbase.no</td>
        <td>Utviklingsmiljø - brukes under utvikling</td>
      </tr>
    </body>
  </table>
</div>

<h2>Oversikt</h2>

<div class="table-responsive">
  <table class="table table-bordered">
    <thead>
      <tr>
        <th>Resurs</th>
        <th>POST</th>
        <th>GET</th>
        <th>PUT</th>
        <th>PATCH</th>
        <th>DELETE</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>/objekttyper</td>
        <td></td>
        <td class="success">Hent typer</td>
        <td></td>
        <td></td>
        <td></td>
      </tr>
      <tr>
        <td>/{type}</td>
        <td class="success">Nytt objekt</td>
        <td class="success">Hent liste</td>
        <td></td>
        <td></td>
        <td></td>
      </tr>
      <tr>
        <td>/{type}/{id}</td>
        <td></td>
        <td class="success">Hent objekt</td>
        <td class="success">Oppdater objekt</td>
        <td class="success">Oppdater objekt</td>
        <td class="success">Slett objekt</td>
      </tr>
    </body>
  </table>
</div>

{% for api in site.data.api %}
  <h2 class="title" id="{{ api.anchor }}">
    <a class="anchor" href="#{{ api.anchor }}">#</a>
    {{ api.title }}
  </h2>

  {% if api.desc %}<p class="desc">{{ api.desc }}</p>{% endif %}

  {% if api.resource %}
    <pre class="resource"><code class="http">{{ api.resource }}</code></pre>
  {% endif %}

  {% if api.params %}<h3 class="params">Parametere</h3><dl>{% endif %}
  {% for param in api.params %}
    <dt>{{ param.name }}</dt>
    <dd>
      <em>{{ param.requ }}</em>
      <strong>{{ param.type }}</strong>
      {% if param.desc %} - {{ param.desc }}{% endif %}
    </dd>
  {% endfor %}
  {% if api.params %}</dl>{% endif %}

  {% if api.request %}
    <h3 class="example">Foresp&oslash;rsel</h3>

    <pre class="headers"><code class="http">{{ api.request.headers }}</code></pre>
    <pre class="highlight"><code class="json">{{ api.request.payload }}</code></pre>
  {% endif %}

  {% if api.response %}
    <h3 class="response">Respons</h3>

    <pre class="headers"><code class="http">{{ api.response }}</code></pre>
    <pre class="highlight"><code class="json">{{ api.data }}</code></pre>
  {% endif %}
{% endfor %}