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



Latest Posts:

Update for Google WorkSpace Accounts (2024): Google Dropping Support for Update for Google WorkSpace Accounts (2024): Google Dropping Support for "Less Secure Apps" May 30th, 2022. What Does This Mean for Your IBM i Email?
Posted by January 19, 2024
BVSTools >> BVSTools Software Discussion >> Email Tools (MAILTOOL) Specific Discussion
Sales By State Report in QuickBooks Online Sales By State Report in QuickBooks Online
Posted by January 13, 2024
QuickBooks >> QuickBooks Online
How to Whitelist GreenTools for G Suite (G4G) For Your Organization How to Whitelist GreenTools for G Suite (G4G) For Your Organization
Posted by November 5, 2023
BVSTools >> BVSTools Software Discussion >> GreenTools for G Suite (Google Apps) (G4G) Specific Discussion
QuickBooks Online Releases QuickBooks Online Releases "New Invoices!"... and It's Terrible!
Posted by October 8, 2023
QuickBooks >> QuickBooks Online
Admin/4i - What is it? Admin/4i - What is it?
Posted by September 30, 2023
Vendor Corner >> MSD Information Technology
BVSTools Releases Send Job Log to BVSTools (SNDLOG2BVS) Command BVSTools Releases Send Job Log to BVSTools (SNDLOG2BVS) Command
Posted by August 28, 2023
BVSTools >> BVSTools Announcements
MAILTOOL Now Allows Email Redirection for Development and Testing MAILTOOL Now Allows Email Redirection for Development and Testing
Posted by May 27, 2023
BVSTools >> BVSTools Announcements >> eMail Tool (MAILTOOL) Specific Announcements
GreenTools for Microsoft Apps (G4MS) Now Supports Footers When Sending Email GreenTools for Microsoft Apps (G4MS) Now Supports Footers When Sending Email
Posted by March 29, 2023
BVSTools >> BVSTools Announcements >> GreenTools for Microsoft Apps (G4MS) Specific Announcements
QuickBooks Online - Subtotals and Discounts Frustration QuickBooks Online - Subtotals and Discounts Frustration
Posted by March 16, 2023
QuickBooks >> QuickBooks Online
Making the Switch From QuickBooks Desktop to QuickBooks Online - No Picnic Making the Switch From QuickBooks Desktop to QuickBooks Online - No Picnic
Posted by March 16, 2023
QuickBooks >> QuickBooks Online
BVSTools Software Verified on V7R5 and Power10 BVSTools Software Verified on V7R5 and Power10
Posted by December 9, 2022
BVSTools >> BVSTools Announcements
Microsoft Office 365 Servers and Random Errors Issue Microsoft Office 365 Servers and Random Errors Issue
Posted by November 14, 2022
BVSTools >> BVSTools Software Discussion >> Email Tools (MAILTOOL) Specific Discussion
Sending/Resending Emails Using a MIME File with MAILTOOL Sending/Resending Emails Using a MIME File with MAILTOOL
Posted by November 8, 2022
BVSTools >> BVSTools Software Discussion >> Email Tools (MAILTOOL) Specific Discussion
Sending an HTML Email on Your IBM i Using MAILTOOL Sending an HTML Email on Your IBM i Using MAILTOOL
Posted by November 1, 2022
BVSTools >> BVSTools Software Discussion >> Email Tools (MAILTOOL) Specific Discussion
Transferring License Keys from One System to Another Transferring License Keys from One System to Another
Posted by October 31, 2022
BVSTools >> BVSTools Software Discussion

Reply




© Copyright 1983-2020 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).