<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
       title="API Overview" id="API-Overview">

    <p>This section provides a high-level overview of how to interact with the API based on <code>openapi.yaml</code>.</p>

    <chapter title="Base URLs" id="base-url">
        <p>The API currently defines the following servers:</p>
        <code-block lang="text">
https://api.truckwash.dk
https://api.truckwash.io
http://localhost/api
        </code-block>
    </chapter>

    <chapter title="Common Headers" id="common-headers">
        <table>
            <tr>
                <td>Header</td>
                <td>Description</td>
            </tr>
            <tr>
                <td>Authorization</td>
                <td>Use Bearer authentication for protected endpoints: <code>Authorization: Bearer &lt;JWT&gt;</code>.</td>
            </tr>
            <tr>
                <td>Accept</td>
                <td>Use <code>application/json</code>.</td>
            </tr>
            <tr>
                <td>Content-Type</td>
                <td>Use <code>application/json</code> for request bodies.</td>
            </tr>
            <tr>
                <td>X-Customer-Number</td>
                <td>Required for many customer-scoped requests when authenticated as a subuser.</td>
            </tr>
        </table>
    </chapter>
</topic>
