Video - InEight Platform
API "Try It" Feature

TRANSCRIPT

One very handy feature is the try it functionality we have built into our developer portal. So if we select APIs at the top here, we'll see a list of different products here. If you don't see a list of products here, then you will have likely not generated a subscription key. For this demonstration, we're gonna go ahead and select core, which is our core platform.

From here, you can see we have some pretty detailed documentation for each of these APIs. They're currently grouped by tag. We're gonna go ahead and turn that off so we can find the one we're waiting for a little bit easier.

Executing a Simple API Call

So here, all we're gonna do is a simple get users.

So as you can see here, we have a description of the API, what it does, the request URL along with any request parameters, headers that are essentially optional.

Understanding Request Body Requirements

From here, we'll go to the request body. We have documentation supporting the request body and what that's gonna look like when you do your API call, along with definitions and more information.

For a majority of the post APIs, we will that will be covered in the documentation.

From here, we're gonna go ahead and try it out.

Okay. Here we have our tried feature.

Authorization Process for API Calls

We have our authorization server. This part auto fills for our authorization flow. We're gonna go ahead and click this drop down and select authorization code. What this is gonna do is it's gonna go ahead and use our single sign on to authenticate and generate the bearer token for us for this try it feature.

Generating Bearer Tokens

We'll be covering how to generate a bearer token via Postman a little bit later. But for now, we'll just use this feature that has built in.

For the purposes here, we're not gonna add any parameters, but these parameters can help you filter, order, and just manipulate the data that you're looking to get from the system.

Header Requirements for API Requests

Regarding headers for this specific list users API, the only header that we're gonna be we're gonna need is the tenant prefix.

The tenant prefix is gonna be the value before the dot h d s in your innate project suite.

You'll enter that as a header in this box here for the Triad feature.

The rest of these, you can kind of leave these be. The subscription key will auto generate and up as well as the authorization token for our authorization step above.

Reviewing Request Structure

From here, we can kind of take a look at what this request looks like. We can change what function we're sending it as, learn to c sharp, Chrome, JavaScript, etcetera.

Then we're gonna go ahead and scroll to the bottom here and we're gonna go ahead and select set.

Now this portion is covered more in the documentation, but you'll notice a location in the response here.

This location is going to be where we're gonna be retrieving our data.

Any API calls that return data that is larger than one kilobyte will be provided in a location, location value.

Retrieving Data via Browser

So for example, if we're to do this in the browser, we can just go ahead and paste, press enter.

And then in for larger requests, it may take a little bit of time for that to populate. But as you can see here, we now have our JSON file.