Project era inventory api: Difference between revisions

Revision as of 07:40, 16 July 2020

This page describes interaction with the API.

Main source for API traversal, lists the resources available to the current (authenticated) user.

used to view and interact with buildings

Used to view and manage characters

Used to view and manage items.

Used to retrieve player information

Some additional information regarding the API

Some resources get signed with an HMAC for additional security, for example, when checking player information it will look something like this:

/api/<HMAC KEY>/players/:uuid

Used to authenticate steam users and redirect to respective player info.

@@ Line 2: / Line 2: @@
 This page describes interaction with the API.
-=== Signed URLs ===
+=== Configuration ===
-Some resources get signed with an HMAC for additional security, for example, when checking player information it will look something like this:
+Main source for API traversal, lists the resources available to the current (authenticated) user.
- /api/<HMAC KEY>/players/:uuid
+=== Buildings ===
+used to view and interact with buildings
+=== Characters ===
+Used to view and manage characters
-=== Authentication ===
+=== Items ===
-Used to authenticate players.
+Used to view and manage items.
- POST /api/authenticate_session
-;Accepts:
-: application/vnd.projectera.auth_session.v1+json
-;Returns:
-: Redirection to player info
 === Players ===
 Used to retrieve player information
-=== Characters ===
+=== Addition Information ===
-Used to manage characters.
+Some additional information regarding the API
+==== Signed URLs ====
+Some resources get signed with an HMAC for additional security, for example, when checking player information it will look something like this:
+ /api/<HMAC KEY>/players/:uuid
-=== Items ===
+==== Steam Authentication ====
-Used to manage items.
+Used to authenticate steam users and redirect to respective player info.