{"info":{"_postman_id":"fc35cc46-4da9-4c05-a401-acf2f20ebc32","name":"Space Beez","description":"

Introduction

\n

Space Beez is a MUD style game using React.js for front-end and Django with Python for the back-end.

\n

Overview

\n

If you'd like to contribute to this repo, please fork and submit a PR.

\n

Authentication

\n

Please make sure you're sending \"Token \" in addition to the key/token for endpoints that require Authorization headers.

\n

Error Codes

\n

Please check the response object in errors for a description of the error.

\n

BaseURL: https://mudierthegame.herokuapp.com/api/

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"}],"owner":"7670132","collectionId":"fc35cc46-4da9-4c05-a401-acf2f20ebc32","publishedId":"SWTG6FoU","public":true,"customColor":{"top-bar":"800080","right-sidebar":"1D1D1D","highlight":"F8C129"},"publishDate":"2020-02-05T18:28:16.000Z"},"item":[{"name":"Register","id":"6d372b08-9d18-466c-9da1-b18bde3428d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/registration/","description":"

Register a new user

\n

Endpoint: /registration/\n
\nRequires an object with a username, password1 and password2:

\n
{\n  \"username\": \"testuser123\",\n  \"password1\": \"password123\",\n  \"password2\": \"password123\"\n}\n
\n

When successful will return status code of 201 (CREATED), and an object containing the key/token (example):

\n
{\n  \"key\": \"39ef2ef932da123b8f91955b813be06fa123ffd3\"\n}\n
\n","urlObject":{"protocol":"https","path":["api","registration",""],"host":["mudierthegame","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"6de28a6f-ba3d-4dd9-9af1-72550fce6023","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/registration/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6d372b08-9d18-466c-9da1-b18bde3428d8"},{"name":"Login","id":"50762252-a689-4fb5-b00f-0a2e0821b232","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/login/","description":"

Login an existing user

\n

Endpoint: /login/\n
\nRequires an object with a username, password:

\n
{\n  \"username\": \"testuser123\",\n  \"password\": \"password123\"\n}\n
\n

When successful will return status code of 200 (OK), and an object containing the key/token (example):

\n
{\n  \"key\": \"39ef2ef932da123b8f91955b813be06fa123ffd3\"\n}\n
\n","urlObject":{"protocol":"https","path":["api","login",""],"host":["mudierthegame","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"81d91a72-78ca-4b52-8d0d-265b78b0ec80","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/login/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"50762252-a689-4fb5-b00f-0a2e0821b232"},{"name":"Initialize Player","id":"3be04437-3f3b-4a1d-ad63-f8c656887e01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/adv/init/","description":"

Get user's initial position/room

\n

Endpoint: /adv/init/\n
\nRequires Authorization key in headers with token as the value.

\n

When successful will return status code of 200 (OK), and an object containing the user and room details (example):

\n
{\n  \"uuid\": \"a303434f-e5cc-4a5a-9ad9-46d7ac24c75b\",\n  \"name\": \"testuser\",\n  \"title\": \"hive-e87\",\n  \"x_coor\": 0,\n  \"y_coor\": 42,\n  \"description\": \"Son a Bee***, this planet smells of adj geyser\",\n  \"nextRooms\": [\n    {\n      \"n\": 1027\n    },\n    {\n      \"e\": 1051\n    },\n    {\n      \"s\": 1071\n    },\n    {\n      \"w\": 0\n    }\n  ],\n  \"players\": []\n}\n
\n","urlObject":{"protocol":"https","path":["api","adv","init",""],"host":["mudierthegame","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"fcfcaf5d-113b-402f-8d40-7f3723a7a1de","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/adv/init/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"3be04437-3f3b-4a1d-ad63-f8c656887e01"},{"name":"Move Player","id":"fae74b31-bda6-4b7a-9150-4580046e9e33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/adv/move/","description":"

Move player to another room

\n

Endpoint: /adv/move/\n
\nRequires Authorization key in headers with token as the value.\n
\nRequires a request object with the direction:

\n
{\n  \"direction\": \"n\"\n}\n
\n

When successful will return status code of 200 (OK), and an object containing the user and room details (example):

\n
{\n  \"name\": \"admin\",\n  \"title\": \"hive-w315\",\n  \"description\": \"Perplexed by the ordinary twin stars, you trod along past the invisible, habitat.\",\n  \"players\": [],\n  \"nextRooms\": [\n    {\n      \"n\": 1005\n    },\n    {\n      \"e\": 1028\n    },\n    {\n      \"s\": 1050\n    },\n    {\n      \"w\": 0\n    }\n  ],\n  \"error_msg\": \"\"\n}\n
\n","urlObject":{"protocol":"https","path":["api","adv","move",""],"host":["mudierthegame","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"71d9bc74-d09f-40fb-b0b3-0c1e1fb0464d","name":"Default","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/adv/move/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fae74b31-bda6-4b7a-9150-4580046e9e33"},{"name":"Get all rooms","id":"5caa5c45-02de-4a86-983c-4acbaa2adcd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/adv/matrix/","description":"

Get a matrix of the room map

\n

Endpoint: /adv/matrix/\n
\nNo token, request body, or headers required.\n
\nRequires a response object with the direction:

\n
{\n  \"direction\": \"n\"\n}\n
\n

When successful will return status code of 200 (OK), and an array of arrays containing 1s and 0s that signify which are rooms and which are not.

\n","urlObject":{"protocol":"https","path":["api","adv","matrix",""],"host":["mudierthegame","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"9ff3fe8a-b698-466f-9f35-88ccf3c4ee1e","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://mudierthegame.herokuapp.com/api/adv/matrix/"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5caa5c45-02de-4a86-983c-4acbaa2adcd7"}],"event":[{"listen":"prerequest","script":{"id":"9d834c1c-d31f-438b-a3dd-10029ac00170","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3f49fa27-4df7-416d-a2d0-02900fc4bf1a","type":"text/javascript","exec":[""]}}]}