This Powershell module is a wrapper for the use of one or more API(s). Each API can be configured and addressed independently. This allows easy use of multiple APIs within a session.
- Dynamic selection of initialized APIs
- oAuth2 (incl. automatic refresh when the token expires)
- Proxy Function
- Basic Auth
- Logging
Insall this Module
Install-Module -Name PSAPIClient
Download this Module
git clone https://github.com/ThomasWilla/PSAPIClient.git -single-branch
Import Module
import-module 'PATH TO MODULE\PSAPIClient\PSAPIClient.psd1'
Initial one ore more API Instance
Set-APIoAuth2Configuration -ClientID YOUR_CLIENT_ID -ClientSecret YOUR_CLIENT_SECRET -TokenEndpoint YOUR_TOKEN_ENDPOINT_URL -APIEndpoint YOUR_API_ENDPOINT_URL -Instance YOUR_INSTANCE_NAME
Get the Access Token from API Instance
Get-APIoAuth2AccessToken -SelectRunningInstance SELECT_YOUR_INSTANCE -RefreshToken YOUR_TOKEN
Invoke Rest Call to the API Instance
Invoke-APIoAuth2WebRequest -SelectRunningInstance SELECT_YOUR_INSTANCE -Method GET/POST/PUT -ResourcePath "api/v2/anyressource" -Body YOUR_CUSTOM_BODY_WHEN_REQUIRED
Get any Session, Token and API Information from the API Instance
Get-APIoAuth2SessionInformation -SelectRunningInstance SELECT_YOUR_INSTANCE
| Version | Date | Changelog |
|---|---|---|
| 1.0.0 | 23.10.2024 | - oAuth2 Integration |
| 1.1.0 | 29.10.2024 | - Porxy Server functionallity |
| 1.1.1 | 05.11.2024 | - Extension for user-defined settings in the header for Invoke-APIOAuth2WebRequest (-AddCustomHeaderSettings [Hashtable]) |
| 1.1.2/3 | 25.11.2024 | - Bugfixing |
| 1.1.4 | 27.11.2024 | - Add Invoke-APIOAuth2WebRequest (-BodyAsJson [sting]) in case of customize format body json (ex. -Detph X -Compress). So you can use (-Body [hastabel]) or (-BodyAsJson [sting]) |
- Thomas Willa - Initial work - ThomasWilla
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details