We strive to keep our APIs backward compatible. We often add new features, but rarely do we actually break old APIs. When we do break APIs we'll log those changes here for you.
Note also that we do not document all the incremental changes as that would mostly be information overload. We only note major API changes here.
Deprecated the Printed Component API in TGC. We have no estimated date where it will be removed, but we are no longer using it ourselves, as we're using a new schema API at the endpoint: https://www.thegamecrafter.com/api/tgc/products
We will be discontinuing a compatibility layer we created in December of 2020. Further, we'll be merging some APIs, for example BoxFace and BoxTop will likely be merged into OneSided.
All of these changes should take place over the first 3 months of 2021 and will be announced as they happen. We are sorry for the inconvenience. If you have questions please contact info@thegamecrafter.com.
We've added a new WebHook API so that your applications can be notified when events occur in our system.
We have removed the old fashioned notify_of_sale_via_postback_uri on Designers in favor of our new WebHooks system.
This release breaks the API for OneSidedSlugged. It now requires a OneSidedSluggedSet, similiar to the relationship between Cards and Decks. This example will create a Set, and then add a OneSidedSlugged object to it.
curl -X POST -F session_id=SESSIONIDGOESHERE -F name="Jeffs Dice Stickers" -F game_id="XXX" -F identity="DiceSticker" https://www.thegamecrafter.com/api/onesidedsluggedset curl -X POST -F session_id=SESSIONIDGOESHERE -F name="D6_4 Face6" -F quantity="99" -F set_id="XXX" https://www.thegamecrafter.com/api/onesidedslugged
This release breaks the API for TwoSidedSlugged. It now requires a TwoSidedSluggedSet, similiar to the relationship between Cards and Decks. This example will create a Set, and then add a TwoSidedSlugged object to it.
curl -X POST -F session_id=SESSIONIDGOESHERE -F name="My Square Tiles" -F game_id="XXX" -F identity="SquareTile" https://www.thegamecrafter.com/api/twosidedsluggedset curl -X POST -F session_id=SESSIONIDGOESHERE -F name="Green Square Tile" -F set_id="XXX" https://www.thegamecrafter.com/api/twosidedslugged
This release breaks the API for TwoSided. It now requires a TwoSidedSet, similiar to the relationship between Cards and Decks. This example will create a Set, and then add a TwoSided object to it.
curl -X POST -F session_id=SESSIONIDGOESHERE -F name="My Skinny Mats" -F game_id="XXX" -F identity="SkinnyMat" https://www.thegamecrafter.com/api/twosidedset curl -X POST -F session_id=SESSIONIDGOESHERE -F name="Player1 Skinny Mat" -F set_id="XXX" https://www.thegamecrafter.com/api/twosided
Added the "Bulk Create Cards" in Deck endpoint.
Added the "Grid Image Upload" in File endpoint.
We've replaced our old game component APIs with new ones, but we've built in some short-term backward compatibility so everything is still working as it was. You should migrate to these new APIs as soon as possible as we'll be removing the compatibility layer in early 2021.
All game component APIs have been affected. The gist of the change is that instead of an end point per component, we are now having 1 endpoint per component type. For example /api/pokerdeck becomes /api/deck. When you create a deck you specify what type it is by passing an identity parameter, such as PokerDeck. These changes are documented inside of each of the APIs, so check out Deck as an example.
Thus:
curl -X POST -F session_id=SESSIONIDGOESHERE -F name="My Cool Deck" https://www.thegamecrafter.com/api/pokerdeck
Would instead become:
curl -X POST -F session_id=SESSIONIDGOESHERE -F name="My Cool Deck" -F identity=PokerDeck https://www.thegamecrafter.com/api/deck
We're moving into a new era now that we have our new game editor out. As such the old changes don't matter anymore.