Skip to main content

ProxyApi

All URIs are relative to http://localhost

MethodHTTP requestDescription
callProxyPOST /proxyCalls a pre-defined proxy service with the provided data

callProxy#

/*** @returns ProxyResult**/async function callProxy(body: ProxyCallParameters)

Calls a pre-defined proxy service with the provided data

Notes:#

Returns the response from the proxied service as a string

Example#

const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let body = new YatJs.ProxyCallParameters(); // ProxyCallParameters // populate body...
try {  let res = await api.proxy().callProxy(body);  // res is of type ProxyResult  console.log('API called successfully. Result: ', res);} catch (error) {  console.error(error);}

Parameters#

NameTypeDescriptionNotes
bodyProxyCallParameters

Return type#

ProxyResult

Authorization#

apiKey

HTTP request headers#

  • Content-Type: Not defined
  • Accept: /