Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Authentication to be used by Client system for calling Increff APIs (inbound calls)

In order to use any of the Increff’s Standard APIs, some headers need to be passed with the request.

These headers are used to authenticate the calls made by external entities and would be shared with client once a client channel pair is being made.

Http headers

Code Block
languagetextbash
authUsername:client-name-122344
authPassword:client-pass-code
authDomainName:clientName-domain

 

Authentication to be used by Increff system for calling Client APIs (outbound calls)

Increff system can send key value pairs in headers for authenticating client APIs.

When client system throws a 401 HTTP status in any of the API calls then Increff system triggers a “Get Credential ” api to client system to re-fetch the new credentials.

Client can also provide static key value pairs to be sent as Headers, which can be configured from Increff UI. In this case client does not need to implement a get credential call. As key value pair won't change.