{{
`${userDetail.user.displayName}${userDetail.user.cachedBungieGlobalDisplayNameCode ? `#${standardizeBungieGlobalCode(userDetail.user.cachedBungieGlobalDisplayNameCode)}` : ""}`}}
{{getUserClans()}}
originally posted in:BungieNetPlatform
View Entire Topic
2/2/2016 9:40:24 PM
1
What is a valid search query for SearchUsers/?q={search} endpoint?
I've started playing around with the BNET API and I came across this method "SearchUsers/?q={search}" under https://www.bungie.net/platform/user/help/. There are two issues with it:-
1. The official documentation of this endpoint says nothing about what some valid search criteria (i.e {search}) could be. I have worked with various APIs in the past and each company defines the search parameters differently. This is very poor documentation.
2. The documentation for this endpoint says nothing about needing the APIKey to always be added to the request header. Or is it the default? If I try a HTTP GET request on that end point, I get the "Please add valid X-API-Key header to request" error status back which means the API KEY is always required. Can someone confirm? Also, this is a PUBLIC end-point as per the documentation. Then why does it require an API key to access the end point?
-
1 ReplyEdited by lowlines: 2/3/2016 1:31:36 AMThe API Key system was introduced back around October as a way to monitor who is making requests. For Bungie.net, "public" means the endpoint does not need a user to be authenticated (with PSN or Xbox) in order to complete the request, and also means it is officially supported by the developers if you run into problems. Documentation is minimal because they are busy making an awesome game and making all the players happy with new features and squashing naughty "pushing bosses with grenades off ledges" bugs. That and at some point, this community started documenting them overselves on http://bungienetplatform.wikia.com/wiki/Bungienetplatform_Wikia Unfortunately some of the more helpful posts here get lost in the sea of help posts, making it kind of like a beach after the tide comes in :p
