|
|
@@ -66,11 +66,11 @@
|
|
|
<h2>Documentation</h2>
|
|
|
<div class="row">
|
|
|
<section id="avatars">
|
|
|
- <a href="#avatars"><h3>Avatars</h3></a>
|
|
|
+ <h3><a href="#avatars">Avatars</a></h3>
|
|
|
<div class="code"><%= domain %>/avatars/<mark class="green">uuid</mark>
|
|
|
</div>
|
|
|
<section id="avatar-parameters">
|
|
|
- <a href="#avatar-parameters"><h4>Avatar Parameters</h4></a>
|
|
|
+ <h4><a href="#avatar-parameters">Avatar Parameters</a></h4>
|
|
|
<table class="table table-striped">
|
|
|
<thead>
|
|
|
<tr>
|
|
|
@@ -105,7 +105,7 @@
|
|
|
</table>
|
|
|
</section>
|
|
|
<section id="avatar-examples">
|
|
|
- <a href="#avatar-examples"><h4>Avatar Examples</h4></a>
|
|
|
+ <h4><a href="#avatar-examples">Avatar Examples</a></h4>
|
|
|
<div class="code">
|
|
|
<div id="avatar-example-1" class="example-wrapper">
|
|
|
<div class="example"><%= domain %>/avatars/853c80ef3c3749fdaa49938b674adae6</div>
|
|
|
@@ -137,12 +137,12 @@
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="renders">
|
|
|
- <a href="#renders"><h3>3D Renders</h3></a>
|
|
|
+ <h3><a href="#renders">3D Renders</a></h3>
|
|
|
<p>Crafatar also provides support for 3D renders of Minecraft skins.<br>
|
|
|
Please note that <b>this feature is currently beta</b>!<br>
|
|
|
The <b>head</b> render type returns a render of the skin's head.<span class="code"><%= domain %>/renders/head/<mark class="green">uuid</mark></span>The <b>body</b> render returns a render of the entire skin.<span class="code"><%= domain %>/renders/body/<mark class="green">uuid</mark></span></p>
|
|
|
<section id="render-parameters">
|
|
|
- <a href="#render-parameters"><h4>Render Parameters</h4></a>
|
|
|
+ <h4><a href="#render-parameters">Render Parameters</a></h4>
|
|
|
<table class="table table-striped">
|
|
|
<thead>
|
|
|
<tr>
|
|
|
@@ -177,7 +177,7 @@
|
|
|
</table>
|
|
|
</section>
|
|
|
<section id="render-examples">
|
|
|
- <a href="#render-examples"><h4>Render Examples</h4></a>
|
|
|
+ <h4><a href="#render-examples">Render Examples</a></h4>
|
|
|
<div class="code">
|
|
|
<div id="render-example-1" class="example-wrapper">
|
|
|
<div class="example"><%= domain %>/renders/body/853c80ef3c3749fdaa49938b674adae6?helm&scale=4</div>
|
|
|
@@ -193,12 +193,12 @@
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="skins">
|
|
|
- <a href="#skins"><h3>Skins</h3></a>
|
|
|
+ <h3><a href="#skins">Skins</a></h3>
|
|
|
<p>You can also get the full skin file of a player.<br>
|
|
|
The user's skin is returned, or the default image is served.<br>
|
|
|
You can use the default parameter here as well.<span class="code"><%= domain %>/skins/<mark class="green">uuid</mark></span></p>
|
|
|
<section id="skin-parameters">
|
|
|
- <a href="#skin-parameters"><h4>Skin Parameters</h4></a>
|
|
|
+ <h4><a href="#skin-parameters">Skin Parameters</a></h4>
|
|
|
<table class="table table-striped">
|
|
|
<thead>
|
|
|
<tr>
|
|
|
@@ -221,7 +221,7 @@
|
|
|
</table>
|
|
|
</section>
|
|
|
<section id="skin-examples">
|
|
|
- <a href="#skin-examples"><h4>Skin Examples</h4></a>
|
|
|
+ <h4><a href="#skin-examples">Skin Examples</a></h4>
|
|
|
<div class="code">
|
|
|
<div id="skin-example-1" class="example-wrapper">
|
|
|
<div class="example"><%= domain %>/skins/853c80ef3c3749fdaa49938b674adae6</div>
|
|
|
@@ -237,14 +237,14 @@
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="capes">
|
|
|
- <a href="#capes"><h3>Capes</h3></a>
|
|
|
+ <h3><a href="#capes">Capes</a></h3>
|
|
|
<p>A cape endpoint is also available to get the active cape of a user.<br>
|
|
|
The user's cape is returned, otherwise a 404 is returned.<br>
|
|
|
<div class="code"><%= domain %>/capes/<mark class="green">uuid</mark>
|
|
|
</div>
|
|
|
</p>
|
|
|
<section id="cape-examples">
|
|
|
- <a href="#cape-examples"><h4>Cape Examples</h4></a>
|
|
|
+ <h4><a href="#cape-examples">Cape Examples</a></h4>
|
|
|
<div class="code">
|
|
|
<div id="cape-example-1" class="example-wrapper">
|
|
|
<div class="example"><%= domain %>/capes/61699b2ed3274a019f1e0ea8c3f06bc6</div>
|
|
|
@@ -260,21 +260,21 @@
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="meta">
|
|
|
- <a href="#meta"><h2>Meta</h2></a>
|
|
|
+ <h2><a href="#meta">Meta</a></h2>
|
|
|
<section id="meta-cors">
|
|
|
- <a href="#meta-cors"><h3>CORS</h3></a>
|
|
|
+ <h3><a href="#meta-cors">CORS</a></h3>
|
|
|
<p>Crafatar supports CORS so you can make AJAX request from within the browser!</p>
|
|
|
</section>
|
|
|
<section id="meta-http-headers">
|
|
|
- <a href="#meta-http-headers"><h3>HTTP Headers</h3></a>
|
|
|
+ <h3><a href="#meta-http-headers">HTTP Headers</a></h3>
|
|
|
<p>Responses come with these HTTP headers, useful for debugging.<br>
|
|
|
Please note that these headers are cached by CloudFlare <small>(CF-Cache-Status: HIT)</small>.</p>
|
|
|
<section id="meta-response-time">
|
|
|
- <a href="#meta-response-time"><h4>Response-Time</h4></a>
|
|
|
+ <h4><a href="#meta-response-time">Response-Time</a></h4>
|
|
|
<p>The time, in milliseconds, it took Crafatar to process the request.</p>
|
|
|
</section>
|
|
|
<section id="meta-x-storage-type">
|
|
|
- <a href="#meta-x-storage-type"><h4>X-Storage-Type</h4></a>
|
|
|
+ <h4><a href="#meta-x-storage-type">X-Storage-Type</a></h4>
|
|
|
<p>Details about how the requested image was stored on the server</p>
|
|
|
<ul>
|
|
|
<li><b>none</b>: No external requests. Cached: User has no skin.</li>
|
|
|
@@ -289,13 +289,13 @@
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section id="meta-x-request-id">
|
|
|
- <a href="#meta-x-request-id"><h4>X-Request-ID</h4></a>
|
|
|
+ <h4><a href="#meta-x-request-id">X-Request-ID</a></h4>
|
|
|
<p>The internal ID assigned to this request.<br>
|
|
|
If you think something is wrong with your request, please <a href="#contact">contact us</a> and provide this ID.</p>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="usernames">
|
|
|
- <a href="#usernames"><h3>About Usernames</h3></a>
|
|
|
+ <h3><a href="#usernames">About Usernames</a></h3>
|
|
|
<p>
|
|
|
We <strong>strongly</strong> advise you to use UUIDs instead of usernames! UUIDs never change while usernames do.<br>
|
|
|
Looking up players by username has officially been deprecated by Mojang ever since UUIDs were introduced.<br>
|
|
|
@@ -306,19 +306,19 @@
|
|
|
</p>
|
|
|
</section>
|
|
|
<section id="meta-about-uuids">
|
|
|
- <a href="#meta-about-uuids"><h3>About UUIDs</h3></a>
|
|
|
+ <h3><a href="#meta-about-uuids">About UUIDs</a></h3>
|
|
|
<p>UUIDs may use the blank or dashed format.<br>
|
|
|
Malformed UUIDs are rejected.</p>
|
|
|
</section>
|
|
|
<section id="meta-about-caching">
|
|
|
- <a href="#meta-about-caching"><h3>About Caching</h3></a>
|
|
|
+ <h3><a href="#meta-about-caching">About Caching</a></h3>
|
|
|
<p>Crafatar caches skins for <%= config.caching.local / 60 %> minutes before checking for skin changes.<br>
|
|
|
Images are cached in your browser for <%= config.caching.browser / 60 %> minutes until a new request to Crafatar is made.<br>
|
|
|
When you changed your skin you can try clearing your browser cache to see the change faster.</p>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="contact">
|
|
|
- <a href="#contact"><h2>Contact</h2></a>
|
|
|
+ <h2><a href="#contact">Contact</a></h2>
|
|
|
<ul>
|
|
|
<li>Follow us on twitter <a href="https://twitter.com/crafatar" target="_blank">@crafatar</a></li>
|
|
|
<li>Open an issue <a href="https://github.com/crafatar/crafatar/issues" target="_blank">on GitHub</a></li>
|
jomo