Skip to content

Releases: CSOIreland/Server-API-Library

4.3.0

20 Nov 13:01

Choose a tag to compare

API.Performance implemented to collect server performance indicators:

  • Add the API_PERFORMANCE_ENABLED key in the AppSettings of the Web.config
  • If you enable this new feature, then you must complete first the following steps:
    • Create the table TD_PERFORMANCE in you database by running the SQL script available at root/db/td_performance.sql
    • Add your Application pool in IIS (i.e. XXXXXX) to the Performance Monitor Users group.

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\XXXXXX and click on Check Names to validate.

image

  • Open the Command Line or PowerShell as Administrator.

image

  • Run iisreset for all changes to take immediately effect.

image

4.2.0

20 Oct 10:10

Choose a tag to compare

API.Utility static class fixed:

  • API.Utility.IpAddress suppressed. Use the public API.Utility.GetIP() instead.
  • API.Utility.UserAgent suppressed. Use the public API.Utility.GetUserAgent() instead.
  • API.Utility.HttpGET suppressed. Use the JSONRPC_API and RESTful_API public member httpGET.
  • API.Utility.HttpPOST suppressed. Use the JSONRPC_API and RESTful_API public member httpPOST.

4.1.3

19 Oct 15:08

Choose a tag to compare

API Authentication mechanism fixed when AD (Active Directory) is down or unreachable

4.1.2

17 Aug 09:36

Choose a tag to compare

  • New public method API.MemCacheD.GetStats() implemented

4.1.1

27 Jul 15:49

Choose a tag to compare

  • 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

30 Jun 14:47

Choose a tag to compare

  • RESTful implementation added
  • Add the new API.RESTful handler 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_MAINTENANCE
    • API_JSONRPC_AUTHENTICATION_TYPE >> API_AUTHENTICATION_TYPE
    • API_JSONRPC_STATELESS >> API_STATELESS
    • API_JSONRPC_SUCCESS >> API_SUCCESS

4.0.1

05 Mar 23:10

Choose a tag to compare

  • API.Utility.GetIP method fixed when HttpContext.Current is null and the IPHostEntry is returned instead
  • API.Utility.GetUserAgent method fixed when HttpContext.Current is null and a blank string 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
	<!-- JSONRPC - Maintenance flag [TRUE, FALSE] -->
	<add key="API_JSONRPC_MAINTENANCE" value="FALSE" />

4.0.0

26 Feb 10:22

Choose a tag to compare

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

    • data property renamed to result
    • error.code changed to type integer
    • error.message changed to type string
    • error.data added as type dynamic
  • New Methods added

    • API.Utility.GetUserAcceptLanguage()
    • API.Utility.EncodeBase64FromUTF8()
    • API.Utility.EncodeBase64FromByteArray()
  • Header RESPONSE_Server overridden and enableVersionHeader set to false following the OWASP security best practice.

3.0.6

19 Dec 18:28

Choose a tag to compare

  • Methods fixed to handle an empty or null input:
    • API.Utility.GZipCompress
    • API.Utility.GZipDecompress

3.0.5

26 Nov 18:42

Choose a tag to compare

  • New Methods added:
    • API.Utility.GZipCompress to compress a string with GZip
    • API.Utility.GZipDecompress to decompress a string with GZip
  • Class API.MemCacheD enhanced to compress/decompress cached data automatically