axway-requester v1.0.1
axway-requester
Module for HTTP requests based on Axway technology.
Building
npm run buildProject Info
This is the module we use to communicate with the third party APIs e.g. Twilio. Usually we could use sdk or a module like request. However in the case of OpenApi Service Connectors based on Axway, we use superagent.
To sum up the module info:
Responsible for HTTP communication with various APIs.
Uses Axway technology under the hood.
Facade to Axway technology used in all OpenApi Service Connectors.
Configuration parameters
The following table represent all available configuration parameters.
| Config params | Description |
|---|---|
| 'x-vendor-openapi-authtype' | authentication type i.e. basic, apiKey or oAuth2 |
| 'x-vendor-openapi-username' | basic authentication type requires to provide username |
| 'x-vendor-openapi-password' | basic authentication type requires to provide password |
| 'x-vendor-openapi-key' | apiKey authentication type requires to provide key |
| 'x-vendor-openapi-token' | oAuth2 authentication type requires to provide access token |
| 'x-vendor-openapi-uri' | uri is constructed by protocol e.g. HTTP, host i.e. server name and basePath |
| 'x-vendor-openapi-uri.protocol' | application protocol i.e. transfer protocol such as HTTP/HTTPs |
| 'x-vendor-openapi-uri.host' | server name |
| 'x-vendor-openapi-uri.port' | specifies the port on which the host system listens for requests. This parameter is optional. The default one will be set, depends on the protocol. |
| 'x-vendor-openapi-uri.basePath' | basePath is the path to the API/Api version etc. |
Author
Axway R&D support@axway.com https://axway.com
License
This code is closed source and Confidential and Proprietary to Axway, Inc. All Rights Reserved. This code MUST not be modified, copied or otherwise redistributed without express written permission of Axway. This file is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement. Your right to use this software terminates when you terminate your Axway subscription.