Platform API Access

Appxite Updated by Appxite

Introduction

This article guides users through accessing and using the AppXite Developer Portal to execute API calls in production or test environments. It covers the signup process, subscription management, and API execution through a web browser, with notes on replicating requests in tools like Postman.

In this article:

The AppXite Developer Portal enables users to manage access and execute API calls in production or test environments through a web browser. API calls can also be replicated in API tools like Postman using the same access rules.

NOTE! Using the Developer Portal is a self-service process. However, AppXite Support can help if needed. Submit a support request for assistance with accessing or using the portal.

Access the Developer Portal

The AppXite Developer Portal is available at developer.appxite.com.

Platform APIs can be executed in two ways:

  • In a web browser on the Developer Portal at developer.appxite.com
  • In API tools (like Postman) using authorization through the bearer token (API Client credentials)
NOTE! For API Client credentials, submit a ticket with AppXite Support. This article focuses on the Developer Portal only.

Sign up for the Developer Portal

  1. Navigate to the signup page: https://developer.appxite.com/signup
  2. Complete the registration form with your details
  3. Submit your registration

Sign in to the Developer Portal

After signing up, navigate to the sign-in page and log in with your credentials: https://developer.appxite.com/signin

Subscribe to API products

Once logged in, you need to subscribe to Products to access their APIs.

  1. Navigate to the products page: https://developer.appxite.com/product
  2. Select the Product you want to use
  3. Enter a subscription name in the designated field
  4. Click the Subscribe button

By Product, it is meant grouped API calls related to specific functionalities.

NOTE! It can take 1-2 days before your subscription is approved. Access is granted based on the email address you used during the signup process. For example, Customers are granted access to Production or Sandbox environments based on the access they have in the AppXite Platform.

View your subscriptions

All subscriptions you have subscribed to can be viewed on your Profile page: https://developer.appxite.com/profile

Execute API calls

After subscribing to a Product, you are ready to explore and execute API calls.

Navigate to the APIs page

  1. Go to the APIs page: https://developer.appxite.com/apis
  2. Browse the available APIs or search for a specific one
  3. Select the API you want to execute
  4. Click the Try It button

Authenticate your request

Make sure to select the authorization code and authenticate with your Platform User credentials to obtain the bearer token.

The process is intuitive, with clear visual guidance in the interface. For detailed documentation, refer to: https://developer.appxite.com/Docs

Replicate requests in Postman

The same request executed in the Developer Portal can be replicated in Postman or other API tools.

To replicate a request, use:

  • The same request type (e.g., GET or POST)
  • The same request URL
  • At least all mandatory headers, plus any optional headers you used

This allows you to integrate API calls into your development workflow or automation tools.

Summary

The AppXite Developer Portal provides a self-service way to access and execute Platform APIs through a web browser. Users can sign up, subscribe to API products, and execute calls with minimal setup. The portal also supports replicating requests in tools like Postman for integration into development workflows.

For additional assistance, contact support by submitting a ticket with AppXite Support.

Postman Developer Portal Developer API compliant rw_v1 API Access

Was this article helpful?

0 out of 0 found this helpful

Articles in this section

Add comment

Please sign in to leave a comment.