top of page

API Documentation 

Section Overview

In this section, we will be exploring how to make requests for blog post data as well as what blog data looks like. We will go over how to get a list of all current blog posts and how to fetch a specific post and its data. Blog posts are articles written by the team at Blue Screen Studios that not only show up on our news page which can be found at bluescreenstudios.net/news, but also can be fetched through the BSS API!

Getting post Identifiers

All blog posts have an identifier associated with them that helps our service provider distinguish each post from one another. In order to get the data associated with a blog post, you will need to pass its identifier into the request URI.

 

To get a list of identifiers for our blog entries you will need to make a GET request to https://bluescreenstudios.net/_functions/blogEntries

API Docs blogEntries

The response you receive should look similar to the image above, containing a status code and an array of strings. This array contains strings representative of the identifiers associated with all available blog posts. Check the JSON Objects - Quick Reference for more information on what JSON data should be in your response.

Getting Posts

Now it's time to get post data! To get a post's data you will need to pass into your request the identifier of the post you wish to get data on. When passing in your post identifier use the the parameter name id.

​

To get a post's data you will need to make a GET request to https://bluescreenstudios.net/_functions/blogEntries?id=POST_ID_HERE

​

The response you receive should include various fields with information about the blog post. Check the JSON Objects - Quick Reference for more information on what JSON data should be in your response.

JSON Objects - Quick Reference

The following tables represent objects returned via the API

blogEntries Response Object
blogEntry Response Objct

Go make cool stuff!

That's it for this page. Go explore other pages in our documentation make something awesome!

bottom of page