bvstone

Using GETURI to Make OAuth 2.0 Requests - Custom Headers for Access Tokens

Posted:

Using GETURI to Make OAuth 2.0 Requests - Custom Headers for Access Tokens

Now that OAuth 2.0 is becoming a lot more prevalent with RESTful API and web service calls, we are getting a lot of questions on how to send the tokens to the server using GETURI.  If you are looking for a way to automate the retrieval and refreshing of OAuth 2.0, that is a separate subject and you are welcome to contact us for help with that.

But, once you have the token and need to pass it in the HTTP headers, normally it is sent similar to:

Authorization: Bearer <access_token>

The <access_token> string is replaced with your current OAuth 2.0 token.

If you are using the GETURI command or the API, both methods require that you use the User Defined Headers.  

Command:

GETURI URI(....)
USRHDR((Authorization 'Bearer <acess_token>')) 

As you can see, the USRHDR paramter is used to pass both the user defined header (Authorization) and the data (Bearer <access_token>).  Prompting the GETURI command will show you the two separate lines to enter these values.  Of course, you can enter more than one user defined header as well.

If you are using the API, it is a little different:

Clear GetUri_In;                                                   
                                                                   
GI_URI = '...';
                       
GI_NbrHdrs = 1;                                                    
GI_UsrHdr(1) = 'Authorization';                                    
GI_UsrHdrDta(1) = 'Bearer <access_token>';        

// complete the rest of the variables before the call to GETURIRG

As you see in this example, GI_NbrHdrs is used to specify how many user headers you will be sending.

GI_UsrHdr and GI_UsrHdrDta will represent the header and data (respectivley) to send to the server.  Please note that these two parameters are defined as arrays, so you will need to index them as well, as shown in this example.

If you are using the ILE functions, it would be like this:

#geturi_resetValues();
#geturi_setValue('gi_uri':'www.webservice.com/application/function');
#geturi_addHeader('Authorization':'Bearer ' + %trimr(token));
...

So, as shown here specifying custom HTTP headers for your RESTful request is quite simple.  Feel free to contact us with any questions.

 


Last edited 12/01/2021 at 16:17:07




Reply




Copyright 1983-2024 BVSTools
GreenBoard(v3) Powered by the eRPG SDK, MAILTOOL Plus!, GreenTools for Google Apps, jQuery, jQuery UI, BlockUI, CKEditor and running on the IBM i (AKA AS/400, iSeries, System i).