What is the purpose of the REST Header Field List?

Justin Hewitt shared this question 2 years ago
Answered

In REST mode, what is the purpose of the HEADER LIST field?

Best Answer
photo

More complex REST services require header instructions as well as a base URL and parameters. Below is a simple example of a service that requires information passed to it in the header. Firstly, we always recommend for more complex REST type connections, that you establish the REST service works using a tool like POSTMAN

e.g.

Let’s try this REST service that provides Japanese Prefecture information

https://opendata.resas-portal.go.jp/api/v1/prefectures

In POSTMAN, lets first just try the end point URL.

We can see that the endpoint has returned a response, meaning that the endpoint is active and is rejecting the request. Now let’s add the required authorization token as a HEADER element. We now get the JSON data correctly.

Now let’s do the same with the Yellowfin JSON Connector

We know the URL -> https://opendata.resas-portal.go.jp/api/v1/prefectures


We have an AUTH Token X-API-KEY: nJT0hp6WNl4eDSVS22EBscCWJnmOioM9WNpgTLNo

Let us first change the (:) symbol to (=) X-API-KEY= nJT0hp6WNl4eDSVS22EBscCWJnmOioM9WNpgTLNo

Now we can enter these values into the JSON connector

Now we are good to proceed with normal JSON connector management.

If your REST service has multiple header elements, then they need to be delimited

by a semi-colon (;) character

X-API-KEY= nJT0hp6WNl4eDSVS22EBscCWJnmOioM9WNpgTLNo;x-jpn-requestor=yellowfin

photo
1

More complex REST services require header instructions as well as a base URL and parameters. Below is a simple example of a service that requires information passed to it in the header. Firstly, we always recommend for more complex REST type connections, that you establish the REST service works using a tool like POSTMAN

e.g.

Let’s try this REST service that provides Japanese Prefecture information

https://opendata.resas-portal.go.jp/api/v1/prefectures

In POSTMAN, lets first just try the end point URL.

We can see that the endpoint has returned a response, meaning that the endpoint is active and is rejecting the request. Now let’s add the required authorization token as a HEADER element. We now get the JSON data correctly.

Now let’s do the same with the Yellowfin JSON Connector

We know the URL -> https://opendata.resas-portal.go.jp/api/v1/prefectures


We have an AUTH Token X-API-KEY: nJT0hp6WNl4eDSVS22EBscCWJnmOioM9WNpgTLNo

Let us first change the (:) symbol to (=) X-API-KEY= nJT0hp6WNl4eDSVS22EBscCWJnmOioM9WNpgTLNo

Now we can enter these values into the JSON connector

Now we are good to proceed with normal JSON connector management.

If your REST service has multiple header elements, then they need to be delimited

by a semi-colon (;) character

X-API-KEY= nJT0hp6WNl4eDSVS22EBscCWJnmOioM9WNpgTLNo;x-jpn-requestor=yellowfin