Files
api/documentation/_site_rebuild_20260317/api-overview.html
T

20 lines
5.5 KiB
HTML

<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2026-03-17T15:38:08.113413637"><title>API Overview | Copenhagen Truck Wash API</title><script type="application/json" id="virtual-toc-data">[{"id":"base-url","level":0,"title":"Base URLs","anchor":"#base-url"},{"id":"common-headers","level":0,"title":"Common Headers","anchor":"#common-headers"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="API Overview | Copenhagen Truck Wash API"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Copenhagen Truck Wash API Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/api-overview.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="API Overview | Copenhagen Truck Wash API"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
"@context": "http://schema.org",
"@type": "WebPage",
"@id": "writerside-documentation/api-overview.html#webpage",
"url": "writerside-documentation/api-overview.html",
"name": "API Overview | Copenhagen Truck Wash API",
"description": "",
"image": "",
"inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
"@type": "WebSite",
"@id": "writerside-documentation/#website",
"url": "writerside-documentation/",
"name": "Copenhagen Truck Wash API Help"
}</script><!-- End Schema.org --></head><body data-id="API-Overview" data-main-title="API Overview" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs=""><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Copenhagen Truck Wash API Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="API-Overview" id="API-Overview.topic">API Overview</h1><p id="qiufyk_2">This section provides a high-level overview of how to interact with the API based on <code class="code" id="qiufyk_5">openapi.yaml</code>.</p><section class="chapter"><h2 id="base-url" data-toc="base-url">Base URLs</h2><p id="qiufyk_6">The API currently defines the following servers:</p><div class="code-block" data-lang="none">
https://api.truckwash.dk
https://api.truckwash.io
http://localhost/api
</div></section><section class="chapter"><h2 id="common-headers" data-toc="common-headers">Common Headers</h2><div class="table-wrapper"><table class="wide" id="qiufyk_8"><thead><tr class="ijRowHead" id="qiufyk_9"><th id="qiufyk_14"><p>Header</p></th><th id="qiufyk_15"><p>Description</p></th></tr></thead><tbody><tr id="qiufyk_10"><td id="qiufyk_16"><p>Authorization</p></td><td id="qiufyk_17"><p>Use Bearer authentication for protected endpoints: <code class="code" id="qiufyk_18">Authorization: Bearer &lt;JWT&gt;</code>.</p></td></tr><tr id="qiufyk_11"><td id="qiufyk_19"><p>Accept</p></td><td id="qiufyk_20"><p>Use <code class="code" id="qiufyk_21">application/json</code>.</p></td></tr><tr id="qiufyk_12"><td id="qiufyk_22"><p>Content-Type</p></td><td id="qiufyk_23"><p>Use <code class="code" id="qiufyk_24">application/json</code> for request bodies.</p></td></tr><tr id="qiufyk_13"><td id="qiufyk_25"><p>X-Customer-Number</p></td><td id="qiufyk_26"><p>Required for many customer-scoped requests when authenticated as a subuser.</p></td></tr></tbody></table></div></section><div class="last-modified">17 March 2026</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="introduction.html" class="navigation-links__prev">Introduction</a><a href="authentication.html" class="navigation-links__next">Authentication</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.26.0-b913/app.js"></script></body></html>