API Call

What is an API call

The API component provides the capability for the application and the user to easily integrate with 3rd party systems send request in order to update data or retrieve data. If an external application wants to send data to an application then this is explained in Camlin API Channel*

How to use an API call
API SettingsAttribuesDescription
API Creation
  • Name
  • Type
  • Info
  • Headers
  • Payload
  • Wait
  • Retry
  • Secured
  • Encode Body params
  • Asynchronous Execution
  • Set the name of the API operation
  • Se the type of URL request required and payload format
  • Provide an optional description on the API
  • Define any Request headers required
  • abc
  • Set the wait / timeout value of request
  • Set the number of retry attempts required on error
  • Choose Security settings, predefined in Security tab
  • Base64 Encode the request parameters
  • Make request in Asynchronous mode
API Configuration

Request

  • Variable
  • Type
  • Name

N.B. Ensure all variables required are preconfigured within the Variable View.

  • Choose the variable value to send on URL request
  • Select how the variables should be sent
  • If required RENAME the variable to be sent.

Response

  • Variable

N.B. Ensure all variables required are preconfigured within the Variable View.

  • Choose the list of variables to be used in response 




Search