OnePoint.Library.OnePointLibrary 1.0.0

API Management System

Adding Custom API

Required Fields:

Creating API Example

Note: Configuration must be in valid JSON format needed for your business logic for the given API, which is parsed into a dynamic object with the same properties and values.

Uploaded DLL Example

Parameters Received in Entry Method

Notes:

1. param: Dynamic object deserialized from the received JSON payload from the API. Properties can be accessed statically (param.propertyname) or dynamically (param["propertyname"].Value).
2. config: Dynamic object deserialized from the JSON string set when creating the API.
3. merchantInfo: Dynamic object containing information of merchant or API caller.
4. insertLog: Delegate function invoked for inserting log in APIMS. Accepts custom function name and custom object, returning inserted log ID as a string.
5. updateLog: Delegate function invoked for updating the inserted log in APIMS. Accepts inserted log ID, custom transaction ID if any, and a custom object.
6. exceptionLog: Delegate function invoked for logging exception details in APIMS. Accepts check-point-name, exception object and returns issue ticket ID.
7. dynamicDelegates: Dictionary of delegate functions paired with name, when selected can invoke internal APIMS functions.

Extra Steps for Using Third-Party Libraries

1. Include the third-party referenced DLL file inside the project.
2. Set the DLL properties to Advanced -> Build Action -> Embedded Resource.
3. Create a constructor to load the manifest of the embedded resource in the calling assembly.

Note: The constructor remains the same for all DLLs with third-party library references, except for the namespace.

Execution Flow

1. APIMS checks if the specified namespace and class exist in the uploaded DLL.
2. APIMS verifies if the specified validation and execution methods exist in the uploaded DLL.
3. APIMS calls the custom validation method against the received parameters, returning a Dictionary<string,string> of errors if any, or an empty dictionary (Count=0).
4. If the dictionary is empty, APIMS calls the entry method with the seven specified parameters and returns its result. Otherwise, it displays the error messages.