Reporting API v1/v2 - requesting access

Introduction

This article outlines the process for requesting access to the AppXite Reporting API. The API allows partners and sellers to programmatically retrieve invoicing and financial data for analysis, reporting, and integration purposes.

Access is provided through an API Access Key, which can be requested by following the steps below.

In this article:

• How to Submit a Request
• Default API Access Scope

Eligibility

Access to the AppXite Reporting API is available to:

• All Distributors

• All Direct and Indirect Sellers

How to Submit a Request

To request access, send an email to support@appxite.com with the following details:

Email Format

• To: support@appxite.com

• Subject: AppXite Reporting API Access Request

• Body:
  Please provide access to the AppXite Reporting API. Below are the required details:

  • Portal URL for which API access is requested

  • Email address of the recipient of the API Access Key

  • Scope of organizations the API Access Key should cover

  • (For Distributors only) List of additional endpoint APIs requested (if any)

  • Purpose of API usage

  • Any other relevant information

Once the SAS key has been granted it will be renewed automatically once the initial grant period has passed.

Default API Access Scope

After the request is processed, access is granted to the following API endpoints based on the partner type:

For Distributors

API V1

https://documenter.getpostman.com/view/16319423/UUy39msK#dffa487a-1a1a-436d-8fc6-45f64a92c5a4

• invoice-headers
• invoice-headers/preview
• invoice-rows
• invoice-rows/preview

API V2

https://documenter.getpostman.com/view/29990327/2sA2xpU9fs#a823dd5e-d7aa-42ef-b414-e8d3c246d613

• requester currency-rates
• requester partners currency-rates summary
• requester partner currency-rates

Additional Endpoints (Available Upon Request)

Distributors may also request access to the following additional endpoints in API v1:

• vendor-raw invoice summary
• vendor-raw invoice

For Direct and Indirect Sellers

API V1

https://documenter.getpostman.com/view/16319423/UUy39msK#dffa487a-1a1a-436d-8fc6-45f64a92c5a4

• invoice-headers
• invoice-headers/preview
• invoice-rows
• invoice-rows/preview

API V2

https://documenter.getpostman.com/view/16319423/UUy39msK#dffa487a-1a1a-436d-8fc6-45f64a92c5a4

• requester currency-rates

Summary

To gain access to the AppXite Reporting API, eligible partners must submit a request via email to AppXite Support. Once granted, the API provides access to invoicing and financial data tailored to the partner’s role. Distributors may also request additional endpoints based on business needs.

If you require support with API setup or usage after access is granted, please contact support@appxite.com.