Postman collections

1: Video Contents Kernel API
2: Aura Bridge Postman collection
3: Aura distributed Postman collection
4: Aura Gateway API Postman collection

Postman collections

In this section, you will find all the Postman collections generated in order to test APIs in Aura

Introduction

Postman is an application used for API testing. It is an HTTP client that tests HTTP requests, using a graphical user interface, through which we obtain different types of responses that need to be subsequently validated.

Postman collections are a tidy way to group your requests together so you can save, reuse, and share them with others.

The current document includes the Postman collections generated by Aura Platform Team:

1 - Video Contents Kernel API

Postman Collection - Video Contents Kernel API

Postman collection with sample requests to Video Contents Kernel API

Introduction

This Postman Collection is based in the Video Contents Kernel API.

It includes requests to get token and example requests of TV Search plugin.

Environment and collection files

Download environment and collection and import both files in Postman.

Import collection

To import the collection and environment, you can see the reference info about this process here.

Once the collections are imported, the environment’s values should be completed. Below, a short description about the enviroment’s variables is listed:

administrative_number_es: administrative number of Spanish user.
user_id_es: identifier of Spanish user.
channel_id_es: identifier of Spain channel authentication.
administrative_number_br: administrative number of Brazilian user.
user_id_br: identifier of Brazil user.
channel_id_br: identifier of Brazil channel authentication.
auth_url: authentication URL.
issuer_url: issuer URL.
expiration_token: time to expire the token in seconds.
scope: list of scopes separated with spaces.
purpose: list of purposes separated with spaces.
private_key: private key to get assertion token.
header_key_id: key id for headers to get assertion token.
client_id_es: client id to authenticate a Spanish user.
client_secret_es: client secret password to authenticate a Spanish user.
client_id_br: client id to authenticate a Brazilian user.
client_secret_br: client secret password to authenticate a Brazilian user.
authorization_id_es: authorization id for Spanish user.
authorization_id_br: authorization id for Brazilian user.

The majority of variables imported for this environment have assigned a default value, only the following variables must be completed: private_key, header_key_id, client_secret_es and client_secret_br.

The collection is composed by:

Get token ES request: to get the access token for Spanish users.
Get token BR request: to get the access token for Brazilian users.
ES folder: requests to search in the Spanish video content.
BR folder: requests to search in the Brazilian video content.

How to use this collection

First, select the environment imported, see the process here.

Then, to send a request in the folder ES or BR, it is previously required to send the request Get token ES or Get token BR respectively.

And finally, try to send any request included in the folder ES or BR.

⚠️ When the request response is UNAUTHENTICATED, send the request Get token ES or Get token BR according to each case and try again the previous request.