API Authentication

From
Revision as of 03:36, 12 May 2021 by GrumpyGecko (talk | contribs) (→‎Full auth process)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Giving @Geckos_Bot API access has several advantages:

  • Your profile information is updated every 8 hours automatically. XP gain estimates are very accurate and don't miss relevant data points.
  • Name, guild, castle changes are tracked automatically and you don't need to care about changing this information
  • Your guild role is verified via API. Several tools depend on the guild role saved by the API (e.g. settings restricted for guild leaders, or tools that are set to be allowed only by squires in the guild etc.)
  • Your stock info is processed and can be displayed to show possible crafts for the guild or personal stock

How to activate basic API

To activate the API access, send /auth to @Geckos_Bot. This will give the answer:

Please forward the message from the game bot with the authorization code here.

Then the game bot (@chtwrsbot) will send you a message like this one here:

 Code 719821 to authorize TheGrumpyGecko_GeckoBot. This app will have the access to:
 - to read your guild info (stock, lobby, etc..)
 - read your profile information
 - read your stock info
 - to view your craft or alchemists book

Forward this message to GeckoBot and you're done:

Succesfully granted API access.

Additional API rights

If you want to allow the GeckoBot to see and process your equipped gear information, just follow the same steps as they are done in the chapter "How to activate basic API" described. Just replace the /auth command with /auth_gear:

Please forward the message from the game bot with the authorization code here.

And the game bot answers:

Code 889868 to authorize TheGrumpyGecko_GeckoBot. This app will have the access to:
- view currently equipped gear

Forward this message to @Geckos_Bot again:

Additional rights granted succesfully.


Full auth process example

Size=300px