STATS API: AN INTRODUCTION

Transcription

1 1

2 STATS API: AN INTRODUCTION 2

3 STATS API: AN INTRODUCTION Presented by Andrew Flintosh, Senior Developer 7 years at STATS LLC Florida State University alumn 3

4 STATS MAIN DELIVERY METHODS FTP Push Requires client to have an FTP server Requires client to have file storage and/or system to database files XML Only FTP Pull Requires client to have file storage and/or system to database files Better for retrieving single files at a time XML Only HTTP Get Requires client to have file storage and/or system to database files Better for retrieving multiple files at a time XML Only API No file storage or database requirement XML or JSON REST based service Optional: HTTP Post 4

5 WHAT IS AN API? Programming Interface Assists Hiring of Developers Assists Developers Devs can start on creating applications nearly instantly Software to Software Not a user interface 5

6 WHAT IS AN API? Seamless Fast On-Demand Conducive to mobile environments Scalable Light users would not need a database or file system Caching is recommended for all users, light and heavy, but not required Caching is an easier way to keep calls down to prevent you from hitting your maximum 6

7 STATS API Mashery ( Security (authentication & authorization) Signature = API Key + Secret + Timestamp Why? -- Client quota protection -- Keeps pricing down Call Quotas Flexible depending on client need Caching Mashery caches each URI call, including parameters Reports Over 142 million total calls since January 1 st, 2015 API HTTP Post Only receive data when it s updated -- Protects your quota limit -- No need for special logic to make certain calls once a day Requires file processing/storage on the client side 7

8 BAD CALLS, BAD! Avoid making these calls more than a 1-2 times a day Full season events/schedules /v1/stats/basketball/nba/events?season=2015 Year to date player or team stats /v1/stats/basketball/nba/stats/players?teamid=3 /v1/stats/basketball/nba/stats/teams/4 /v1/stats/basketball/nba/stats/players/3254 Check the date first /v1/stats/basketball/nba/datedataupdated /v1/stats/basketball/nba/eventdataconfirmed 8

9 I/O DOCS Note: You must have an API Key in order to utilize I/O Docs. Contact a STATS Sales Representative or Project Manager to get yours. Decodes Elements can have an ID property Textual representation of IDs 9

10 I/O DOCS QUERY STRING PARAMETERS 10

11 I/O DOCS SAMPLE RETURN recordcount Most endpoints this is a count of how many records are returned For /EVENTS/ it is how many games are in the result set timetaken Time taken by STATS to build the result set Not the time taken from request made to receipt Rendering, like through I/O docs, can take considerable time for larger calls. 11

12 OTHER GETTING STARTED LINKS Documentation This is where you ll find our Data Dictionaries. Data Dictionaries contain for each endpoint - Element lists - Data types for each element - Element samples - Structural details of returned objects - Availability information (some elements) Blog Sample calls General Do s and Don ts 12

13 SIGNATURE? I/O Docs Sample URI 27&languageId=4&accept=json&api_key=y3gu38jufnmvaf44mz8ffq8x&sig=1588d89de547994cc48c9fb2b8d429348b4ce7b3d7e42e6d06131d610620bb14 sig=1588d89de547994cc48c9fb2b8d429348b4ce7b3d7e42e6d06131d610620bb14 Not a random letter/number generator SHA256 Encoded string API Key Secret Timestamp Number of seconds since the Unix Epoch (January 1, :00:00 GMT) Allows Mashery to quickly verify call is legitimate Legitimate insofar as correct API Key and Secret are being used Changing the API Secret will stop unauthorized calls Pitfalls Using the wrong key for a particular service you are subscribed and trying to access Server time being off Even if you re only off by a minute or two, this will result in an Unauthorized error Incorrect hashing algorithm (SHA256 only) 13

14 ENOUGH WORDS SHOW ME STUFF!! This sample is written in C# Not in a.net environment? Contact your Project Manager, they have a number of other language samples at the ready 14

15 I CAN MAKE A CALL NOW WHAT? You can now start building your application JSON and XML are text Text can be read and used as a data format in any programming language Check out the Data Dictionaries mentioned on Slide 11 Other getting started links to start coding in your native language or 15

16 API STARTER KIT.NET Framework 4.5 DLL to add to your application Can be found on Why? No more wasting time getting started One Object to rule them all All endpoints can populate a single object No need to create your own Facilitates server side code Should you rely on this in a production environment? Not (yet?) Good for quickly getting started on proof of concept or familiarizing yourself with the STATS API 16

17 WOULD YOU LIKE TO KNOW MORE? 17

18 SEAMLESS 18

19 APISTARTERKIT.DLL Requires Microsoft.AspNet.WebApi.Client version or higher No error handling Class Name = STATSApi 2 Constructors STATSApi() STATSApi(string api_key, string api_secret) 4 Methods string getsignature() string getsignature(string api_key, string api_secret) apireturn geturiasobject(string uri, string api_key = null, string api_secret = null) Utilizes a return type of BSON for deserialization into STATSAPIDataClasses HttpResponseMessage geturiashttpresponse(string uri, string api_key = null, string api_secret = null) Cannot use STATSAPIDataClasses to deserialize 19

20 LAST BUT NOT LEAST Visit stats.com Don t miss our next webinar, SportVU: A Look Under the Hood, on June 10 Questions? 20

21 21