Update CompanionAppApi.md

This commit is contained in:
Josh Freeman
2019-04-01 10:05:53 +01:00
committed by GitHub
parent c4f5a1f5f1
commit 6552ccd606
+4
View File
@@ -4,10 +4,14 @@
The FINAL FANTASY XIV companion app has the ability to query the game servers for a specific resource to pull information (market info, retainer items, player items, chat messages, etc). This document will list research and provide logic for obtaining data out of the app as well as quering the companion API.
___
# Ban Notice
> **IMPORTANT: If you spam the Sight API with a lot of requests in a short period. SE will ban you. This is not automated but is final with no warning. Be very careful how you access the API and if possoble use a dummy account, Twitch Prime starter keys will work. You only need to make a character and enter the game, you do not even need to step forward. Once the character has been logged in it will have Companion Accesss**
___
What we know:
- The Companion App Queries a PHP 7 server.