spacetraders/api-docs
1
0
Fork 0
mirror of https://github.com/SpaceTradersAPI/api-docs.git synced 2024-11-15 06:40:51 +01:00
Code Issues Packages Projects Releases Wiki Activity

update to v2 api endpoint

Browse Source
This commit is contained in:
Space Admiral 2023-01-25 09:03:57 -08:00
parent 8877039b7c
commit 06b500b760
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/quickstart.md
View File

@ -40,7 +40,7 @@ brew install httpie
You can then hit any API endpoint by simplying typing `https` along with the http method and the url. You can test this by hitting the game status endpoint which will tell us if the game is currently available to play: You can then hit any API endpoint by simplying typing `https` along with the http method and the url. You can test this by hitting the game status endpoint which will tell us if the game is currently available to play:
```bash ```bash
https GET v2-0-0.rc-2.spacetraders.io https GET v2.api.spacetraders.io
``` ```
```json ```json
@ -80,7 +80,7 @@ Every agent is identified by a unique call sign (such as `ZER0` or `SP4CE_TR4DER
- [x] `CORSAIRS` - The Seventh Space Corsairs are a feared group of pirates and raiders who operate throughout the galaxy, preying on merchant ships and plundering valuable cargo. - [x] `CORSAIRS` - The Seventh Space Corsairs are a feared group of pirates and raiders who operate throughout the galaxy, preying on merchant ships and plundering valuable cargo.
```bash ```bash
https POST v2-0-0.rc-2.spacetraders.io/register \ https POST v2.api.spacetraders.io/register \
symbol=ZER0 \ symbol=ZER0 \
faction=COSMIC faction=COSMIC
``` ```
@ -113,7 +113,7 @@ Copy your token somewhere safe and set it as a variable in your command prompt.
apiToken=<your-token-here> apiToken=<your-token-here>
shipSymbol=<your-ship-symbol-here> shipSymbol=<your-ship-symbol-here>
contractId=<your-contract-id> contractId=<your-contract-id>
apiUrl=v2-0-0.rc-2.spacetraders.io apiUrl=v2.api.spacetraders.io
``` ```
<!-- theme: warning --> <!-- theme: warning -->

8
reference/SpaceTraders.json
View File

@ -5,13 +5,13 @@
"email": "joel@spacetraders.io", "email": "joel@spacetraders.io",
"name": "Joel Brubaker" "name": "Joel Brubaker"
}, },
"description": "SpaceTraders is a multiplayer sci-fi strategy game where you acquire and manage a fleet of ships across a growing and dynamic universe.\n\nSimilar to games such as Eve Online, you work with or against other players to establish trade routes, chart new systems, mine precious ores, patrol for pirates, spy on factions, and discover hidden treasures.\n\nSpaceTraders as a game is unique in that it is entirely accessible through open and well-documented API endpoints.\n\nIf this sounds fun and interesting to you, please drop into our Discord and get to know the community. We are actively working on new clients, new ideas and sharing tips for how to play the game.\n\n\n```json http\n{\n \"method\": \"GET\",\n \"url\": \"https://api-server-2-0-0-rc-2-vxxwq5xqdq-uc.a.run.app\",\n}\n```", "description": "SpaceTraders is a multiplayer sci-fi strategy game where you acquire and manage a fleet of ships across a growing and dynamic universe.\n\nSimilar to games such as Eve Online, you work with or against other players to establish trade routes, chart new systems, mine precious ores, patrol for pirates, spy on factions, and discover hidden treasures.\n\nSpaceTraders as a game is unique in that it is entirely accessible through open and well-documented API endpoints.\n\nIf this sounds fun and interesting to you, please drop into our Discord and get to know the community. We are actively working on new clients, new ideas and sharing tips for how to play the game.\n\n\n```json http\n{\n \"method\": \"GET\",\n \"url\": \"https://v2.api.spacetraders.io\",\n}\n```",
"license": { "license": {
"name": "No Permission", "name": "No Permission",
"url": "https://choosealicense.com/no-permission/" "url": "https://choosealicense.com/no-permission/"
}, },
"title": "SpaceTraders API", "title": "SpaceTraders API",
"version": "2.0.0-rc.2" "version": "2.0.0"
}, },
"security": [ "security": [
{ {
@ -20,8 +20,8 @@
], ],
"servers": [ "servers": [
{ {
"description": "v2.0.0-rc.2", "description": "v2",
"url": "https://v2-0-0.rc-2.spacetraders.io" "url": "https://v2.api.spacetraders.io"
} }
], ],
"tags": [ "tags": [