2017-01-11 13:50:06 +01:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta http-equiv = "X-UA-Compatible" content = "IE=edge" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< title > DecAPI Docs< / title >
< link href = "https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cosmo/bootstrap.min.css" rel = "stylesheet" integrity = "sha384-h21C2fcDk/eFsW9sC9h0dhokq5pDinLNklTKoxIZRUn3+hvmgQSffLLQ4G4l2eEr" crossorigin = "anonymous" >
< link href = "https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel = "stylesheet" integrity = "sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin = "anonymous" >
2017-01-11 14:34:11 +01:00
< style media = "screen" >
body {
padding-bottom: 80px;
}
.fa-heart {
color: #be1931;
}
2017-01-12 11:28:08 +01:00
#back-to-top:hover {
cursor: pointer;
text-decoration: underline;
}
2017-01-11 14:34:11 +01:00
< / style >
2017-01-11 13:50:06 +01:00
< / head >
< body >
< nav class = "navbar navbar-default" role = "navigation" >
< div class = "container-fluid" >
< div class = "navbar-header" >
< a class = "navbar-brand" href = "#" > DecAPI Docs< / a >
< / div >
2017-01-12 11:28:08 +01:00
< ul class = "nav navbar-nav navbar-right" >
< li > < a href = "https://github.com/Decicus/DecAPI-Docs" > < i class = "fa fa-1x fa-book" > < / i > DecAPI Docs on GitHub< / a > < / li >
< li > < a href = "https://github.com/Decicus/DecAPI" > < i class = "fa fa-1x fa-github" > < / i > DecAPI on GitHub< / a > < / li >
2017-01-11 13:50:06 +01:00
< / ul >
< / div >
< / nav >
< div class = "container-fluid" id = "content" >
< i class = "hidden fa fa-1x" id = "fa-template" > < / i >
< div class = "hidden" id = "base-template" >
< div class = "page-header" >
< h4 > < i class = "fa fa-1x fa-fw" > < / i > < span > < / span > < / h4 >
< / div >
< / div >
2017-01-12 12:01:12 +01:00
< div class = "panel panel-success hidden" id = "endpoint-template" >
2017-01-11 13:50:06 +01:00
< div class = "panel-heading" >
< h3 class = "panel-title" id = "title" >
2017-01-12 12:01:12 +01:00
< a href = "#" > < span id = "base" > < / span > < span id = "route" > < / span > < / a >
2017-01-11 13:50:06 +01:00
< / h3 >
< / div >
< div class = "panel-body" id = "main-body" >
< p class = "text-warning" > Notes:< / p >
< ul id = "description" class = "list-group text-primary" > < / ul >
< pre > < strong class = "text-primary" > < / strong > < code > < / code > < / pre >
< div id = "routes" class = "hidden" >
< p class = "text-warning" > Route parameters:< / p >
< table class = "table table-bordered" id = "route-body" >
< thead >
< tr >
< th > Parameter name:< / th >
< th > Description:< / th >
< th > Required:< / th >
< th > Type:< / th >
< / tr >
< / thead >
< tbody > < / tbody >
< / table >
< / div >
< div id = "qs" class = "hidden" >
< p class = "text-warning" > Query string parameters:< / p >
2017-01-11 15:48:45 +01:00
< table class = "table table-bordered table-striped table-hover" id = "qs-body" >
2017-01-11 13:50:06 +01:00
< thead >
< tr >
< th > Parameter name:< / th >
< th > Description:< / th >
< th > Required:< / th >
< th > Type:< / th >
< / tr >
< / thead >
< tbody > < / tbody >
< / table >
< / div >
< / div >
< / div >
< div class = "page-header" >
< h1 > DecAPI Docs< / h1 >
< / div >
< div class = "panel panel-primary" >
< div class = "panel-heading" >
< h3 class = "panel-title" > General information< / h3 >
< / div >
< div class = "panel-body" >
These pages will house the documentation of endpoints under DecAPI.
< br >
2017-01-14 01:47:02 +01:00
This is currently < strong > work in progress< / strong > and < strong > incomplete< / strong > , which means that some endpoints lack documentation or may not be fully documented.
< br >
2017-01-15 03:23:30 +01:00
If you would like to contribute, take a look at the < a href = "https://github.com/Decicus/DecAPI-Docs" > < i class = "fa fa-github fa-1x" > < / i > GitHub repository< / a > for this documentation.
2017-01-11 13:50:06 +01:00
< / div >
< / div >
< div class = "panel panel-primary" >
< div class = "panel-heading" >
< h3 class = "panel-title" > Default options & results< / h3 >
< / div >
< div class = "panel-body" >
< p > These are options or results that will be the default, < strong > unless the notes about the endpoint mention otherwise< / strong > .< / p >
< div class = "list-group" >
2017-01-14 01:47:02 +01:00
< li class = "list-group-item" > The base URL for all endpoints is < code > http://beta.decapi.me< / code > or < code > https://beta.decapi.me< / code > .< / li >
< li class = "list-group-item" > < strong > HTTP< / strong > requests are supported, but < strong > HTTPS (TLS 1.x)< / strong > is encouraged.< / li >
2017-01-11 13:50:06 +01:00
< li class = "list-group-item" > The default HTTP method supported is < code > GET< / code > .< / li >
< li class = "list-group-item" > Responses are < code > Content-Type: text/plain< / code > .< / li >
2017-01-14 01:47:02 +01:00
< li class = "list-group-item" > For endpoints that mention JSON support without any further information, send < code > Accept: application/json< / code > in the request header to receive the response as JSON instead.< / li >
2017-01-11 13:50:06 +01:00
< li class = "list-group-item" > Parameters are < strong > always< / strong > required.< / li >
< li class = "list-group-item" > Query strings are < strong > never< / strong > required.< / li >
2017-01-31 10:58:06 +01:00
< li class = "list-group-item" > Parameter/query string examples may be surrounded by "curly brackets", for example: < code > {USERNAME}< / code > . These should be omitted in the actual requests.< / li >
2017-01-11 13:50:06 +01:00
< / div >
< / div >
< / div >
2017-01-11 15:48:45 +01:00
< div class = "panel panel-primary hidden" id = "toc" >
< div class = "panel-heading" >
2017-01-14 01:47:02 +01:00
< h3 class = "panel-title" > < a href = "#toc" > Table of contents:< / a > < / h3 >
2017-01-11 15:48:45 +01:00
< / div >
< div class = "panel-body" >
2017-01-12 11:28:08 +01:00
< p >
The table of contents will only link you to the specific "categories", and not to any specific endpoints.
< br >
However, you can click the path/header for the endpoint and it will allow you to directly link to that section.
< / p >
2017-01-11 15:48:45 +01:00
< div class = "list-group" > < / div >
< / div >
< / div >
2017-01-11 13:50:06 +01:00
< div class = "page-header" >
< h1 > Endpoints:< / h1 >
< / div >
< / div >
2017-01-11 14:34:11 +01:00
< nav class = "navbar navbar-default navbar-fixed-bottom" role = "navigation" >
< div class = "container-fluid" >
2017-01-11 14:45:43 +01:00
< p class = "navbar-text" > Design & layout heavily inspired by < a href = "https://xpaw.me/" class = "navbar-link" > xPaw< / a > from their < a href = "https://lab.xpaw.me/steam_api_documentation.html" class = "navbar-link" > Steam Web API Documentation< / a > . Special thanks < i class = "fa fa-1x fa-heart" > < / i > < / p >
2017-01-12 08:51:58 +01:00
2017-01-12 11:28:08 +01:00
< span class = "pull-right navbar-text" id = "back-to-top" title = "Back to top" > < i class = "fa fa-1x fa-arrow-circle-up" > < / i > Back to top< / span >
2017-01-11 14:34:11 +01:00
< / div >
< / nav >
2017-01-11 13:50:06 +01:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.1.1/jquery.min.js" integrity = "sha256-hVVnYaiADRTO2PzUGmuLJr8BLUSjGIZsDYGmIJLv2b8=" crossorigin = "anonymous" > < / script >
< script src = "https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity = "sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin = "anonymous" > < / script >
2017-02-01 14:47:40 +01:00
< script src = "https://cdnjs.cloudflare.com/ajax/libs/js-yaml/3.7.0/js-yaml.min.js" integrity = "sha256-8PanqYAVOGlOct+i65R+HqibK3KPsXINnrSfxN+Y/J0=" crossorigin = "anonymous" > < / script >
2017-01-11 13:50:06 +01:00
< script src = "./js/main.js" charset = "utf-8" > < / script >
< / body >
< / html >
