Class ApiXClient

A client for an API-X server.

This object serves as a vanilla client that to reach API-X-based APIs.

Making API-X Requests

createDeleteRequest createGetRequest createPatchRequest createPostRequest createPutRequest createRequest makeDeleteRequest makeGetRequest makePatchRequest makePostRequest makePutRequest makeRequest

Other

constructor

Making API-X Requests

createDeleteRequest

  • createDeleteRequest(url, data?): ApiXRequest

  • Creates a new DELETE request object that can be used to reach an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns ApiXRequest

    An ApiXRequest object that can be used to make a request.

createGetRequest

  • createGetRequest(url): ApiXRequest

  • Creates a new GET request object that can be used to reach an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    Returns ApiXRequest

    An ApiXRequest object that can be used to make a request.

createPatchRequest

  • createPatchRequest(url, data?): ApiXRequest

  • Creates a new PATCH request object that can be used to reach an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns ApiXRequest

    An ApiXRequest object that can be used to make a request.

createPostRequest

  • createPostRequest(url, data?): ApiXRequest

  • Creates a new POST request object that can be used to reach an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns ApiXRequest

    An ApiXRequest object that can be used to make a request.

createPutRequest

  • createPutRequest(url, data?): ApiXRequest

  • Creates a new PUT request object that can be used to reach an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns ApiXRequest

    An ApiXRequest object that can be used to make a request.

createRequest

  • createRequest(url, httpMethod?, data?): ApiXRequest

  • Creates a new request object that can be used to reach an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • httpMethod: ApiXHttpMethod = 'GET'

      The HTTP Method to use.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns ApiXRequest

    An ApiXRequest object that can be used to make a request.

makeDeleteRequest

  • makeDeleteRequest(url, data?): Promise<ApiXResponse>

  • Makes a DELETE request to an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns Promise<ApiXResponse>

    An ApiXRequest object that can be used to make a request.

    Throws

    May throw errors that need to be caught.

makeGetRequest

  • makeGetRequest(url): Promise<ApiXResponse>

  • Makes a GET request to an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    Returns Promise<ApiXResponse>

    An ApiXRequest object that can be used to make a request.

    Throws

    May throw errors that need to be caught.

makePatchRequest

  • makePatchRequest(url, data?): Promise<ApiXResponse>

  • Makes a PATCH request to an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns Promise<ApiXResponse>

    An ApiXRequest object that can be used to make a request.

    Throws

    May throw errors that need to be caught.

makePostRequest

  • makePostRequest(url, data?): Promise<ApiXResponse>

  • Makes a POST request to an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns Promise<ApiXResponse>

    An ApiXRequest object that can be used to make a request.

    Throws

    May throw errors that need to be caught.

makePutRequest

  • makePutRequest(url, data?): Promise<ApiXResponse>

  • Makes a PUT request to an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns Promise<ApiXResponse>

    An ApiXRequest object that can be used to make a request.

    Throws

    May throw errors that need to be caught.

makeRequest

  • makeRequest(url, httpMethod?, data?): Promise<ApiXResponse>

  • Makes a request to an API-X-based API.

    Parameters

    • url: URL

      The URL of the API-X endpoint.

    • httpMethod: ApiXHttpMethod = 'GET'

      The HTTP Method to use.

    • Optionaldata: ApiXJsonObject

      The request JSON Body, if any.

    Returns Promise<ApiXResponse>

    An ApiXRequest object that can be used to make a request.

    Throws

    May throw errors that need to be caught.

Other

constructor

  • new ApiXClient(apiKey, appKey): ApiXClient

  • Creates a new instance of an API-X Client.

    Parameters

    • apiKey: string

      The application API Key.

    • appKey: string

      The application signing key.

    Returns ApiXClient

Settings

Member Visibility

On This Page

Making API-X Requests
Other