Cas/ffxiv-datamining
2
0
Fork 0
mirror of https://github.com/xivapi/ffxiv-datamining.git synced 2026-08-01 14:28:41 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CompanionAppApi.md

Browse Source
This commit is contained in:
Josh Freeman
2018-10-09 22:44:44 +01:00
committed by GitHub
parent 1d5c37dcf8
commit 57531f1900
1 changed files with 31 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CompanionAppApi.md
+31 -24
View File
@@ -45,19 +45,25 @@ Once you have a valid token, you can provide it to any endpoint and everything w
```php ```php
<?php <?php
/**
* composer req ramsey/uuid guzzlehttp/guzzle
*/
require __DIR__ .'/vendor/autoload.php'; require __DIR__ .'/vendor/autoload.php';
use GuzzleHttp\Client; use GuzzleHttp\Client;
$headers = [ $headers = [
// Your token, you would need to watch your traffic (eg I use Fiddler) // Your token, you would need to watch your traffic (eg I use Fiddler)
// for this or use: https://github.com/Minoost/libpompom-sharp // for this or use: https://github.com/Minoost/libpompom-sharp
'token' => '<put your token here>', 'token' => '<YOUR TOKEN>',
'request-id' => "lol whatever you want here",
// other random blab // this is your request-id and will affect SE's cache, you will not get up to date
// information until the same request has been made with a different request-id
// so this example just generates a random one each time
'request-id' => time(),
// other random blab - This isn't needed but is nice to have
'Content-Type' => 'application/json;charset=utf-8', 'Content-Type' => 'application/json;charset=utf-8',
'Accept' => '*/*',
'domain-type' => 'global',
'User-Agent' => 'ffxivcomapp-e/1.0.1.0 CFNetwork/974.2.1 Darwin/18.0.0', 'User-Agent' => 'ffxivcomapp-e/1.0.1.0 CFNetwork/974.2.1 Darwin/18.0.0',
]; ];
@@ -73,7 +79,7 @@ $client = new Client([
* /login/characters * /login/characters
* /login/region * /login/region
* *
* base_uri = https://companion-eu.finalfantasyxiv.com * base_uri = https://companion-eu.finalfantasyxiv.com/
* ^^ can be na or ja (i think data center?) * ^^ can be na or ja (i think data center?)
* *
* These require the correct endpoint, eg: * These require the correct endpoint, eg:
@@ -82,31 +88,32 @@ $client = new Client([
* *
* It returns a region, which will be the new 'base_uri' * It returns a region, which will be the new 'base_uri'
* *
* /character/login-status * /character/login-status
* /items/character * /items/character
* /market/items/catalog/18189 (<-- item id , aka "catalogId") *
* /market/items/catalog/18189 (<-- item id , aka "catalogId")
*/ */
// You have to keep hitting the API until you get a 200, // You have to keep hitting the API until you get a 200,
// as it queues requests and processes them in the background // as it queues requests and process them in the background
// This will attempt 15 times delaying for 250ms foreach (range(0, 15) as $second) {
foreach (range(0, 15) as $i) { usleep(200000);
// get market info for item id 18189
$response = $client->get('/sight-v060/sight/market/items/catalog/18189', [ $response = $client->get('/sight-v060/sight/market/items/catalog/5', [
\GuzzleHttp\RequestOptions::HEADERS => $headers, \GuzzleHttp\RequestOptions::HEADERS => $headers,
]); ]);
if ($response->getStatusCode() == 200) { if ($response->getStatusCode() == 202) {
// this is the API JSON data continue;
$data = (string)$response->getBody();
// this is the json response from the server, do something with it.
print_r($data);
break;
} }
// delay for 250 milliseconds if ($response->getStatusCode() == 200) {
usleep(250000); // this is the API JSON data
print_r((string)$response->getBody());
break;
}
print_r($response);
} }
``` ```