Health Check API

​

Feature Release

This is the announcement for an upcoming ASAPP feature. Your ASAPP account team will provide a target release date and can direct you to more detailed information as needed.

​

Overview

ASAPP provides a means for our customers to check the operational status of our API platform. Developers can ping this endpoint to verify that the ASAPP infrastructure is working as expected.

​

Use and Impact

Developers can either check ad hoc if the ASAPP infrastructure is up at a given time or implement automated API monitoring to send a request to the Health Check API at a preset interval.

This feature is intended to improve developer confidence when integrating with ASAPP services. It also removes the need for developers to send requests to other ASAPP services to check their status, which may trigger errors unnecessarily.

​

How It Works

Developers can run a GET https://api.sandbox.asapp.com/v1/health operation and inspect for a 200 response with either the SUCCESS or FAILED value for the status of the core ASAPP platform.

Configuration

Developers must request access to the API endpoint in the Developer Portal:

1. Access the Developer Portal.
2. Navigate to Apps, select your application, and authorize the Health Check API.
3. Reach out to your ASAPP account team to authorize access.