Merged
Conversation
We are now using hogan.js templates
We are now using [this](http://flag-icon-css.lip.is) for flags, flags are in SVG. All countries are in the repository currently, I might remove the ones we aren't using or move to a CDN.
Also changed host to DigitalOcean for EU
For future use, will contain documentation for the sandbox.
The new system will require an API key to access most of our APIs, this is for many reasons some of which are explained on the why_api_key.html page. API keys will require an account, which we are using twitter oauth for.
This is the main account page where people can change their API key, see a history of changes to their key as well as a brief access log. I am planning to add click-to-copy support for the api key to make it easier for people to get their key.
This is going to be the request sandbox. It will show users a code snippet of how to use their desired API. It's primary function is to show people how to add their API key into their request, if they don't know.
The ad system is something which is in heavy development and most likely won't be complete when the main rewrite is done. The terms/rules for ads laid out in these pages may change in the future but can be used as a **rough** guideline. The prices may change also. The current plan for ads is to have one slot at the top of the page and one at the bottom, one ad per user with gifs allowed (manually approved) to avoid annoying ads and make the experience pleasant for our visitors. Also advertisers will receive statistics about their campaign and how it is doing. Advertisements are planned to help fund mc-api, as it is provided as a free service without guarantee or warranty and is very expensive to run, currently being funded by me. If you have any comments or feedback please leave a comment! 😃
Already in backend
If something is cached then the server will not check the api key given or require one at all. This should make cached responses optimum speed, however if the request is not in cache then an api key will be required (unless stated otherwise in the documentation) This may seem like a silly thing to do or have but there are niche use cases for it. For example: Someone is logged into your server, you queried our api about them when they joined. Your website uses javascript which queries our api too, instead of putting your api key in the public javascript (which isn't a good idea) we can return the cached response without the need for an api key.
Will contain the documentation for endpoints in the future I am still unsure if I am going to make this dynamic and use the HAR objects for documentation rather than loads of files
Plan has changed
I prefer the old one still 😛
- Removed line about API docs (that plan is on hold) - Removed build status badge for jenkins - Updated server location to London for EU
in prep for CDN
This file contains a list of files that need to be distributed through KeyCDN
not done the best
This will indicate which server in a cluster served the request
It would be nice if ads could pay for the servers but I don't think that'll happen.
MC-API/Issues#52 Today graph is a bit buggy so might remove that
Bit of a pointless update really but whatever
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As the old files aren't in use anymore, I'll probably merge this at some point to replace it.