Project era inventory api: Difference between revisions

From Delft Solutions
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:
This page describes interaction with the API.
This page describes interaction with the API.


=== Configuration ===
=== Buildings ===
Main source for API traversal, lists the resources available to the current (authenticated) user.
Used to view and interact with buildings


=== Buildings ===
==== SHOW ====
used to view and interact with buildings
Returns:
application/vnd.projectera.building.v1+json


=== Characters ===
=== Characters ===
Used to view and manage characters
Used to view and manage characters


=== Items ===
==== CREATE ====
Requires:
application/vnd.projectera.character.v1.create+json
Returns:
Redirect to created character
 
==== INDEX ====
Returns:
application/vnd.projectera.character.v1.index+json
 
==== SHOW ====
Returns:
application/vnd.projectera.character.v1+json
 
=== Configuration ===
Main source for API traversal, lists the resources available to the current (authenticated) user.
 
==== SHOW ====
Returns:
application/vnd.projectera.configuration.v1+json
 
=== Inventory ===
Used to view and manage items.
Used to view and manage items.
==== SHOW ====
Returns:
application/vnd.projectera.inventory.v1+json


=== Players ===
=== Players ===
Used to retrieve player information
Used to retrieve player information


=== Addition Information ===
==== SHOW ====
Some additional information regarding the API
Returns:
application/vnd.projectera.player.v1+json
 
=== Universe ===
Used to retrieve universe information
 
==== SHOW ====
Returns:
application/vnd.projectera.universe.v1+json
 
== Mediatypes ==
 
=== Building ===
application/vnd.projectera.building.v1+json
Root key:
building
Contents:
None
Links:
inventory
universe
self
 
=== Character ===
application/vnd.projectera.character.v1+json
Root key:
character
Contents:
None
Links:
player
self
 
==== Create ====
application/vnd.projectera.character.v1.create+json
Root key:
character
Contents:
name: String
 
==== Index ====
application/vnd.projectera.character.v1.index+json
Root key:
characters
Contents:
_index: Array of objects containing links to characters
 
=== Configuration ===
application/vnd.projectera.configuration.v1+json
Root key:
configuration
Contents:
None
Links:
self
authenticate_session
 
=== Inventory ===
application/vnd.projectera.inventory.v1+json
Root key:
inventory
Contents:
None
Links:
building (optional)
character (optional)
self


==== Signed URLs ====
=== Player ===
Some resources get signed with an HMAC for additional security, for example, when checking player information it will look something like this:
application/vnd.projectera.player.v1+json
  /api/<HMAC KEY>/players/:uuid
Root key:
player
Contents:
  None
Links:
characters
self


==== Steam Authentication ====
=== Universe ===
Used to authenticate steam users and redirect to respective player info.
application/vnd.projectera.universe.v1+json
Root key:
universe
Contents:
None
Links:
buildings
self

Revision as of 01:11, 11 August 2020

Project ERA inventory API

This page describes interaction with the API.

Buildings

Used to view and interact with buildings

SHOW

Returns: 

application/vnd.projectera.building.v1+json

Characters

Used to view and manage characters

CREATE

Requires: 

application/vnd.projectera.character.v1.create+json

Returns: 

Redirect to created character

INDEX

Returns: 

application/vnd.projectera.character.v1.index+json

SHOW

Returns: 

application/vnd.projectera.character.v1+json

Configuration

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

SHOW

Returns: 

application/vnd.projectera.configuration.v1+json

Inventory

Used to view and manage items.

SHOW

Returns: 

application/vnd.projectera.inventory.v1+json

Players

Used to retrieve player information

SHOW

Returns: 

application/vnd.projectera.player.v1+json

Universe

Used to retrieve universe information

SHOW

Returns: 

application/vnd.projectera.universe.v1+json

Mediatypes

Building

application/vnd.projectera.building.v1+json

Root key: 

building

Contents: 

None

Links: 

inventory
universe
self

Character

application/vnd.projectera.character.v1+json

Root key: 

character

Contents: 

None

Links: 

player
self

Create

application/vnd.projectera.character.v1.create+json

Root key: 

character

Contents: 

name: String

Index

application/vnd.projectera.character.v1.index+json

Root key: 

characters

Contents: 

_index: Array of objects containing links to characters

Configuration

application/vnd.projectera.configuration.v1+json

Root key: 

configuration

Contents: 

None

Links: 

self
authenticate_session

Inventory

application/vnd.projectera.inventory.v1+json

Root key: 

inventory

Contents: 

None

Links: 

building (optional)
character (optional)
self

Player

application/vnd.projectera.player.v1+json

Root key: 

player

Contents: 

None

Links: 

characters
self

Universe

application/vnd.projectera.universe.v1+json

Root key: 

universe

Contents: 

None

Links: 

buildings
self
Retrieved from "https://docs.delftsolutions.nl/index.php?title=Project_era_inventory_api&oldid=25"