Git Product home page Git Product logo

supercell-api's Introduction

supercell-api

Service to provide capability to overcome the static IP limitation of the supercell games API.

PROOF OF CONCEPT: https://statscell.herokuapp.com

ABOUT

This is a service which is developed with the intention to remove the static IP limitation over the supercell games official API (clash of clans). Currently the above mentioned game API requires to have a static IP while generating a key. But many people do not happen to have that, thus this service is developed to overcome the requirement of static IP.

NOTE: This service is working for the above mentioned games, and is tested properly as well. You can have a look at the proof of concept linked at the top of the page.

ENABLING THE OFFICIAL API

By default the API token fetching is disabled i.e. there is nothing working by default apart from the base route response. Keeping in mind that not everyone use every API, all the games API are disabled by default. You can selectively enable the ones you need by setting the respective game value true in config.js.

After setting the value to true, all the official API routes be available for you as well.

HOW IT WORKS ??

This service simply logins to the developer portal at run time and generate a new key for the current IP of your device or host. All the API requests are made using the generated token now. The Service also checks if there is any key for the current host and also deletes old keys to not exceede the limit of keys for your developer account.

EXTRA INFORMATION

  • Currently the API has all the API routes covered for clash of clans, clash royale and brawl stars
  • One can easily customize (add, delete, modify) API routes and their responses simply by visiting the routes folder in the the respective game folder (i.e. clash, royale or brawl)
  • One can setup custom authorization, save the responses to DB or anything as per the needs

HOSTING OVER HEROKU

Thinking about a free platform to use this service, one can already think of Heroku, thus there is a heroku branch with things managed for the heroku Branch. Also This article contains a simple walkthrough to help you host this service over heroku securely.

CONTRIBUTING

If you got any question, have a feature idea, found a bug etc. then you can simply open an issue!

If you rather got something updated and want the community to see what new you have done or improved, then you cna simply make a PR!

CREDITS

  • Brujah: For the original code that gave me the concept of how things work.

If you still are facing problem, then you can contact me at Discord.. [Santosh#2138]

supercell-api's People

Contributors

bsantosh909 avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.