API Usage - Revision history

KJNine: /* Version 2 */

2025-01-12T00:54:14Z

Version 2

← Older revision		Revision as of 00:54, 12 January 2025
Line 37:		Line 37:
	== '''Version 2''' ==		== '''Version 2''' ==

	It is recommended that you only use endpoints from the API Version 2, and store the results in a database for further processing.		It is recommended that you only use endpoints from the API Version 2, and store the results in a database for further processing. Responses in this version are not sorted or filtered (in most cases), allowing for quicker responses, designed for your end-use application to do the sorting and filtering.
	==== Base URL ====		==== Base URL ====
	* <code>https://crafters.one/api/v2</code>		* <code>https://crafters.one/api/v2</code>
Line 48:		Line 48:

	----		----

	== Endpoints ==		== Endpoints ==
	=== Get Player ===		=== Get Player ===

KJNine: /* Endpoints */

2025-01-12T00:52:21Z

Endpoints

@@ Line 88: / Line 88: @@
      "minecraft:recipes/misc/blue_dye": true,
      "minecraft:recipes/transportation/acacia_boat": true,
      ...
      }</code>

KJNine: Add v2 API Docs

2024-09-19T01:04:32Z

Add v2 API Docs

@@ Line 17: / Line 17: @@
 === Base URL ===
-All API requests are made to the following base URL:
+All API requests are made to the following base URLs:
 <code>https://crafters.one/api/v1</code>
@@ Line 29: / Line 35: @@
 The API is rate-limited to 600 requests per 10 minutes per API Key.
 == Endpoints ==
-== Get Player Stats ==
+=== Get Player Stats ===
 ==== Endpoint ====

GlowChad: /* Update top_players parameters */

2024-06-18T02:08:52Z

Update top_players parameters

← Older revision		Revision as of 02:08, 18 June 2024
Line 152:		Line 152:

	* <code>x-api-key</code> (required): Your API key.		* <code>x-api-key</code> (required): Your API key.

			==== Parameters ====

			* <code>stat</code> (required): The [https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Statistic.html#enum-constant-summary bukkit statistic] you want to retrieve.
			* <code>type</code> (optional): The Block, Item, or Entity when using DROP, PICKUP, MINE_BLOCK, USE_ITEM, BREAK_ITEM, CRAFT_ITEM, KILL_ENTITY, ENTITY_KILLED_BY, or TARGET_HIT.
			* <code>limit</code> (optional): The number of top players requested to return in the list. This can be left off to only retrieve the number one player.

	==== Example Request ====		==== Example Request ====

	<code>GET https://crafters.one/api/v1/stats/top_players&stat=STAT_HERE&limit=10</code>		<code>GET https://crafters.one/api/v1/stats/top_players?stat=STAT_HERE&type=TYPE_HERE&limit=10</code>

	==== Response ====		==== Response ====
Line 189:		Line 195:
	}		}
	]		]


	~~==== Additional Information ====~~

	* '''limit=10''': The number of top players requested to return in the list. This can be left off to only retrieve the number one player.


	== Using Postman with CraftersAPI ==		== Using Postman with CraftersAPI ==

Plexiate at 01:27, 12 June 2024

2024-06-12T01:27:13Z

← Older revision		Revision as of 01:27, 12 June 2024
Line 47:		Line 47:
	==== Example Request ====		==== Example Request ====

	<code>GET https://crafters.one/api/v1/stats/players&player=PLAYER_UUID</code>		<code>GET https://crafters.one/api/v1/stats/players?player=PLAYER_UUID</code>

	==== Response ====		==== Response ====

Plexiate: /* CraftersAPI Documentation */

2024-06-10T05:16:20Z

CraftersAPI Documentation

← Older revision		Revision as of 05:16, 10 June 2024
Line 23:		Line 23:
	=== Authentication ===		=== Authentication ===

	All requests to the API must include a valid API key. The API key should be included ~~as a query parameter~~.		All requests to the API must include a valid API key. The API key should be included in the request headers with the key x-api-key.

	=== Rate Limiting ===		=== Rate Limiting ===

	The API is rate-limited to 600 requests per 10 minutes per ~~IP address~~.		The API is rate-limited to 600 requests per 10 minutes per API Key.

	== Endpoints ==		== Endpoints ==
Line 36:		Line 36:

	<code>GET /stats/players</code>		<code>GET /stats/players</code>

			==== Headers ====

			* <code>x-api-key</code> (required): Your API key.

	==== Parameters ====		==== Parameters ====

	* <code>apikey</code> (required): Your API key.
	* <code>player</code> (required): The UUID of the player whose stats you want to retrieve.		* <code>player</code> (required): The UUID of the player whose stats you want to retrieve.

	==== Example Request ====		==== Example Request ====

	<code>GET https://crafters.one/api/v1/stats/players~~?apikey=YOUR_API_KEY~~&player=PLAYER_UUID</code>		<code>GET https://crafters.one/api/v1/stats/players&player=PLAYER_UUID</code>

	==== Response ====		==== Response ====
Line 108:		Line 111:
	<code>GET /stats/world</code>		<code>GET /stats/world</code>

	==== ~~Parameters~~ ====		==== Headers ====

	* <code>~~apikey~~</code> (required): Your API key.		* <code>x-api-key</code> (required): Your API key.

	==== Example Request ====		==== Example Request ====

	<code>GET https://crafters.one/api/v1/stats/world~~?apikey=YOUR_API_KEY~~</code>		<code>GET https://crafters.one/api/v1/stats/world</code>

	==== Response ====		==== Response ====
Line 146:		Line 149:
	<code>GET /stats/top_players</code>		<code>GET /stats/top_players</code>

	==== ~~Parameters~~ ====		==== Headers ====

	* <code>~~apikey~~</code> (required): Your API key.		* <code>x-api-key</code> (required): Your API key.

	==== Example Request ====		==== Example Request ====

	<code>GET https://crafters.one/api/v1/stats/top_players~~?apikey=YOUR_API_KEY~~&stat=STAT_HERE&limit=10</code>		<code>GET https://crafters.one/api/v1/stats/top_players&stat=STAT_HERE&limit=10</code>

	==== Response ====		==== Response ====
Line 210:		Line 213:
	https://crafters.one/api/v1/stats/players		https://crafters.one/api/v1/stats/players

	5. '''Query Parameters''':		5. '''Headers''':
			- Click on the “Headers” tab below the URL field.
			- Add the required query parameters:
			- '''x-api-key''': Your API key.

			6. '''Query Parameters''':
	- Click on the “Params” tab below the URL field.		- Click on the “Params” tab below the URL field.
	- Add the required query parameters:		- Add the required query parameters:
	~~- '''apikey''': Your API key.~~
	- '''player''': The UUID of the player whose stats you want to retrieve.		- '''player''': The UUID of the player whose stats you want to retrieve.

	6. '''Send the Request'''		7. '''Send the Request'''

	7. '''View the Response'''		8. '''View the Response'''

Plexiate at 03:51, 9 June 2024

2024-06-09T03:51:36Z

← Older revision		Revision as of 03:51, 9 June 2024
Line 216:		Line 216:
	- '''player''': The UUID of the player whose stats you want to retrieve.		- '''player''': The UUID of the player whose stats you want to retrieve.

	6. '''Send the Request''':		6. '''Send the Request'''

	7. '''View the Response''':		7. '''View the Response'''

Plexiate at 03:51, 9 June 2024

2024-06-09T03:51:28Z

← Older revision		Revision as of 03:51, 9 June 2024
Line 219:		Line 219:

	7. '''View the Response''':		7. '''View the Response''':
	~~- The response from the API will be displayed in the lower part of the Postman window. If the request is successful, you will see a JSON object containing the player’s statistics.~~

Plexiate at 03:51, 9 June 2024

2024-06-09T03:51:13Z

← Older revision		Revision as of 03:51, 9 June 2024
Line 217:		Line 217:

	6. '''Send the Request''':		6. '''Send the Request''':
	~~- Click on the “Send” button to send the request to the API.~~

	7. '''View the Response''':		7. '''View the Response''':

Plexiate at 03:49, 9 June 2024

2024-06-09T03:49:57Z

← Older revision		Revision as of 03:49, 9 June 2024
Line 9:		Line 9:
	1. '''In-Game Command''': Use the command <code>/craftersapi new <NameOfAPIKey></code> in-game to generate a new API key.		1. '''In-Game Command''': Use the command <code>/craftersapi new <NameOfAPIKey></code> in-game to generate a new API key.

	2. '''Viewing Keys''': Use the command <code>/craftersapi keys</code> to view your ~~active~~ API keys.		2. '''Viewing Keys''': Use the command <code>/craftersapi keys</code> to view your API keys.

	3. '''Cancelling a Key''': Use the command <code>/craftersapi cancel <NameOfAPIKey></code> to cancel an existing API key.		3. '''Cancelling a Key''': Use the command <code>/craftersapi cancel <NameOfAPIKey></code> to cancel an existing API key.

	~~You will be able to view all keys generated by your account, cancelled or active, via the <code>/craftersapi keys</code> command.~~

	== Making Requests ==		== Making Requests ==