NetStone API
API
Release Notes
3.2.020. May 25
This release extends fallback support by handling the more granular privacy settings the Lodestone added. New endpoints allow retrieving characters and free companies from cache by name, and the landing page now shows libraries and their licenses. New
Changed
Removed
|
3.1.130. Apr 25 Changed
Fixed
|
3.1.020. Apr 25
Version 3.0.0 added fallback support for when the Lodestone is entirely unreachable. This version extends this by also allowing fallbacks when the Lodestone is down for maintenance or when a profile is private. If no fallback is used, a 503 HTTP Status Code is returned.
A new .NET SDK replaces the existing API Client, and there is various maintenance-related changes too. New
Changed
|
3.0.124. Mar 25 Changed
Fixed
Maintenance
Breaking Changes
|
3.0.023. Mar 25
This version adds fallback support in case the Lodestone is unreachable. It also adds OpenTelemetry metrics and tracing support. Metrics give me insight in how much the API is used and whether it can process all requests. Tracing data allows me to tune performance and if things went wrong, see where they did. New
Maintenance
Fixed
Removed
Breaking Changes
|
2.1.203. Jan 25
Fixed
|
2.1.105. Nov 24
Fixed
|
2.1.003. Nov 24 New
Changed
Breaking Changes
|
2.0.328. Sep 24
Fixed
|
2.0.227. Sep 24
Fixed
|
2.0.122. Sep 24 Changed
|
2.0.022. Sep 24
Complete revamp of the API. Instead of simply parsing and returning NetStone data, Lodestone data is now mapped onto database entities and cached. Retrieving character data can now return cached data as DTOs, or refresh data from the Lodestone and return as said DTOs. New
|
1.1.015. Jul 24 New
|
1.0.301. Jul 24 Fixed
|
1.0.215. Apr 24 Fixed
|
1.0.127. Jan 24 Fixed
|
1.0.025. Jan 24 Initial Release
|
RabbitMQ
Queues (inbound)
Name | REST API method | Associated Exchanges (see below for details) |
netstone-get-character | /Character/{lodestoneId} | netstone-get-character-result netstone-get-character-refreshed |
netstone-get-character-class-jobs | /Character/ClassJobs/{lodestoneId} |
netstone-get-character-class-jobs-result netstone-get-character-class-jobs-refreshed |
netstone-get-character-minions | /Character/Minions/{lodestoneId} |
netstone-get-character-minions-result netstone-get-character-minions-refreshed |
netstone-get-character-mounts | /Character/Mounts/{lodestoneId} |
netstone-get-character-mounts-result netstone-get-character-mounts-refreshed |
netstone-get-character-achievements | /Character/Achievements/{lodestoneId} |
netstone-get-character-achievements-result netstone-get-character-achievements-refreshed |
netstone-get-free-company | /FreeCompany/{lodestoneId} |
netstone-get-free-company-result netstone-get-free-company-refreshed |
netstone-get-free-company-members | /FreeCompany/Members/{lodestoneId} |
netstone-get-free-company-members-result netstone-get-free-company-members-refreshed |
Exchanges (outbound)
Name | Sent When |
netstone-get-character-result | Character data requested through queue. |
netstone-get-character-refreshed | Character data refreshed from Lodestone. |
netstone-get-character-class-jobs-result | Character's class jobs requested through queue. |
netstone-get-character-class-jobs-refreshed | Character's class jobs refreshed from Lodestone. |
netstone-get-character-minions-result |
Character's minions requested through queue. |
netstone-get-character-minions-refreshed |
Character's minions refreshed from Lodestone. |
netstone-get-character-mounts-result |
Character's mounts requested through queue. |
netstone-get-character-mounts-refreshed |
Character's mounts refreshed from Lodestone. |
netstone-get-character-achievements-result |
Character's achievements requested through queue. |
netstone-get-character-achievements-refreshed |
Character's achievements refreshed from Lodestone. |
netstone-get-free-company-result |
Free Company data requested through queue. |
netstone-get-free-company-refreshed |
Free Company data refreshed from Lodestone. |
netstone-get-free-company-members-result |
Free Company's members requested through queue. |
netstone-get-free-company-members-refreshed |
Free Company's members refreshed from Lodestone. |
- "result" exchanges are always (cached or not) filled when data was requested through inbound queue, NOT when requested through API.
- "refreshed" exchanges are filled whenever data was refreshed from the Lodestone, no matter whether through inbound queue or API. It is however NOT filled when data was returned from cache.
API Client
Release Notes
This project has been archived and replaced with NetStone API SDK.
3.0.124. Mar 25 Breaking Changes
|
3.0.023. Mar 25 New
Maintenance
Breaking Changes
|
2.1.003. Nov 24
New
Fixed
Maintenance
|
2.0.329. Sep 24
Fixed
|
2.0.227. Sep 24
Fixed
Maintenance
|
2.0.122. Sep 24 Maintenance
|
2.0.022. Sep 24
Initial Release
|
SDK
Release Notes
3.2.020. May 25 New
Breaking Changes
|
3.1.226. Apr 25
Purely a maintenance update to keep the NetStone Common module up to date.
|
3.1.125. Apr 25
The old NetStone API Client threw NotFoundExceptions if the response status code was a 404. The new SDK instead threw an ApiException, which was a breaking change and required a dependency on/an import of Refit. It now throws NotFoundExceptions again, and a generic NetStoneException on other unsuccessful response status codes. Fixed
|
3.1.020. Apr 25 Initial Release
|