API: Difference between revisions

From PirateCraft
(Created page with "PirateCraft application programming interface allowing access to data of the PirateCraft ecosystem. == Players API == You can query players data by username or UUID using: su...")
 
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
__TOC__
PirateCraft application programming interface allowing access to data of the PirateCraft ecosystem.
PirateCraft application programming interface allowing access to data of the PirateCraft ecosystem.
This API has been created from scratch by [[GodsDead]] for the website https://piratemc.com


== Players API ==
'''API is NOT currently public, this page has been created as a placeholder'''
 
=== Why? ===
To bring player statistics back to the website live, I needed a new way to get data between the live server and the web-server, so I made a JSON API, since these calls will be public anyway, I thought it best to write up how to use the APIs.
 
==Players API==
You can query players data by username or UUID using:
You can query players data by username or UUID using:
sub.domain.com/player/Username
 
 
<syntaxhighlight lang="bash">
curl https://api.piratemc.com/pirate/<username>
</syntaxhighlight>
 
==Crews API==
This pulls overall data for all crews
 
 
<syntaxhighlight lang="bash">
curl https://api.piratemc.com/crews/<username>
</syntaxhighlight>
 
==Crew API==
This pulls a specific crews data
 
 
<syntaxhighlight lang="bash">
curl https://api.piratemc.com/crew/<username>
</syntaxhighlight>

Latest revision as of 12:29, 14 November 2019

PirateCraft application programming interface allowing access to data of the PirateCraft ecosystem. This API has been created from scratch by GodsDead for the website https://piratemc.com

API is NOT currently public, this page has been created as a placeholder

Why?[edit | edit source]

To bring player statistics back to the website live, I needed a new way to get data between the live server and the web-server, so I made a JSON API, since these calls will be public anyway, I thought it best to write up how to use the APIs.

Players API[edit | edit source]

You can query players data by username or UUID using:


curl https://api.piratemc.com/pirate/<username>

Crews API[edit | edit source]

This pulls overall data for all crews


curl https://api.piratemc.com/crews/<username>

Crew API[edit | edit source]

This pulls a specific crews data


curl https://api.piratemc.com/crew/<username>