paragon-api
v1.0.1
Published
Node wrapper around Paragon API web service
Downloads
7
Readme
paragon-api
A Node.js API client for the web API of Paragon, a game by EPIC Games.
How To Use
- Email [email protected] and request an API key
- Run
npm install --save paragon-api
- Copy config.json.sample or create a config.json (see config.json.sample)
- Add
const paragonApiClient = require('paragon-api')(require('config.json'));
- Make API calls
Supported Endpoints
This client supports all documented API endpoints as of 2016-10-05.
Callback Format
All callbacks need to be passed in such as:
function callback(error, responseBody) {
if (error) handleError(error);
doSomethingWithJSONResponseBody(responseBody);
}
where both error
and responseBody
will be JSON objects based on API documentation. Read: the client calls JSON.parse() on both properties prior to passing them to the callback.
How To Authenticate
- Make a call to authLogin
- This will return an
url
property in the 2nd parameter of the URL to redirect the user to - The user will be redirected, and on success or failure the callback you give to EPIC Games on sign up
- You will be passed back a "code" in the URI (GET) and optionally an "error" if the user cancelled the request
Getting Decks
This is a special case in where once-used-but-not-anymore deck slots will still have an ID but no other attributes. So, the API client will loop through each deck retrieved and filter out the ones that are not valid anymore.
TODO
- Make this use promise-style logic instead
- Support more endpoints when the API is updated
- Add in some extra features??