Loading...

Getting Started with Mediasite API

Course Content

Total learning: 7 lessons Time: 10 weeks

Making your First API Call

Before you can make your first full API call you need to enter in a few pieces of data. You will to set the

  • Method (Verb) which will most often be GET.
  • URL, which is the endpoint you want to reach.
  • The authentication information.

For the first example, to make a call for the list of Presentations on this server. Enter in the following information into Hoppscotch.io:

FieldEntry
MethodGET
URLhttps://SERVER/mediasite/api/v1/Presentations
AuthenticationBasic Authentication then Username and Password
User/PasswordMediasiteAdmin or other user with API Access
Headers - sfapikeyYour API Key (I.e. abcdef44-2404-4e24-9931-0191e1003afb)

Click “Send” and you will see a JSON Response. The results will display “odata.count” with the number of presentations on your server. Below this is an array listing of individual presentations with related metadata.

If you get an authentication error, check to see that your Authentication is correct. If you get a network error, check to see that your Hoppscotch browser extension is enabled.

Try it with some different endpoints like “Profiles”, “Recorders”, “MediasiteChannels”, etc. Reference the MetaData URL for the full list.

You may notice that the number of presentations with metadata listed in this array is not the full list of all presentations. By default, this only shows you 10 presentations. You may also note that only a subset of metadata for the presentations is included. To get additional presentations, and to show all metadata, you need to add parameters.

API Call with Parameters

You can add the parameter to the end of the URL, but you can also easily add it in Hoppscotch using the Parameters tab. Add a new parameter called “$select” with the value “full” and the type “Query”. Send that and you will see the full list of metadata for the presentations including description, thumbnail URL, Presenter, etc. If you want something in the middle, you can also try $select=card for a subset of the full metadata, but more than the initial listing. You can also use a parameter to get more results. “$top=50” will get 50 results instead of the default of 10. “$skip=100” will skip the first 100 results and show you the next results after that. You can combine these to get the results you are looking for.

Was this Information helpful?