Releases: CSOIreland/Server-API-Library
Releases · CSOIreland/Server-API-Library
4.3.0
API.Performance implemented to collect server performance indicators:
- Add the
API_PERFORMANCE_ENABLEDkey in theAppSettingsof the Web.config - If you enable this new feature, then you must complete first the following steps:
- Create the table
TD_PERFORMANCEin you database by running the SQL script available atroot/db/td_performance.sql - Add your
Application poolin IIS (i.e.XXXXXX) to the Performance Monitor Users group.
- Create the table
How to add an Application pool to the Performance Monitor Users group.
- Change the Location to be the local Server
- Add the user by typing
IIS APPPOOL\XXXXXXand click on Check Names to validate.
- Open the Command Line or PowerShell as Administrator.
- Run
iisresetfor all changes to take immediately effect.
4.2.0
API.Utility static class fixed:
API.Utility.IpAddresssuppressed. Use the publicAPI.Utility.GetIP()instead.API.Utility.UserAgentsuppressed. Use the publicAPI.Utility.GetUserAgent()instead.API.Utility.HttpGETsuppressed. Use theJSONRPC_APIandRESTful_APIpublic memberhttpGET.API.Utility.HttpPOSTsuppressed. Use theJSONRPC_APIandRESTful_APIpublic memberhttpPOST.
4.1.3
API Authentication mechanism fixed when AD (Active Directory) is down or unreachable
4.1.2
- New public method
API.MemCacheD.GetStats()implemented
4.1.1
- New public method
Utility.HttpGet()implemented to retrieve the HTTP(s) request for the GET verb - New public method
Utility.HttpPOST()implemented to retrieve the HTTP(s) request for the POST verb
4.1.0
- RESTful implementation added
- Add the new
API.RESTfulhandler to the Web.config
<add verb="GET,POST" path="api.restful" name="API.RESTful" type="API.RESTful" />- Rename the following keys in the Web.*.config files under the
<appSettings>section:API_JSONRPC_MAINTENANCE>>API_MAINTENANCEAPI_JSONRPC_AUTHENTICATION_TYPE>>API_AUTHENTICATION_TYPEAPI_JSONRPC_STATELESS>>API_STATELESSAPI_JSONRPC_SUCCESS>>API_SUCCESS
4.0.1
- API.Utility.GetIP method fixed when
HttpContext.Currentisnulland theIPHostEntryis returned instead - API.Utility.GetUserAgent method fixed when
HttpContext.Currentis null and ablankstring is returned instead - Under maintenance flag implemented in order to disconnect the JSON-RPC listener when the system is under maintenance.
- Add the application setting API_JSONRPC_MAINTENANCE in the
Web.config
- Add the application setting API_JSONRPC_MAINTENANCE in the
<!-- JSONRPC - Maintenance flag [TRUE, FALSE] -->
<add key="API_JSONRPC_MAINTENANCE" value="FALSE" />4.0.0
This Version is NOT backward compatible.
N.B. If you upgrade to this version then you must upgrade the Client API Library to implement the strict JSON-RPC specifications.
-
JSON-RPC response structure fixed to implement strict specifications: https://www.jsonrpc.org/specification
dataproperty renamed toresulterror.codechanged to typeintegererror.messagechanged to typestringerror.dataadded as typedynamic
-
New Methods added
- API.Utility.GetUserAcceptLanguage()
- API.Utility.EncodeBase64FromUTF8()
- API.Utility.EncodeBase64FromByteArray()
-
Header
RESPONSE_Serveroverridden andenableVersionHeaderset tofalsefollowing the OWASP security best practice.
3.0.6
- Methods fixed to handle an
emptyornullinput:- API.Utility.GZipCompress
- API.Utility.GZipDecompress
3.0.5
- New Methods added:
- API.Utility.GZipCompress to compress a string with
GZip - API.Utility.GZipDecompress to decompress a string with
GZip
- API.Utility.GZipCompress to compress a string with
- Class API.MemCacheD enhanced to compress/decompress cached data automatically


