Service Provider API Overview

The Service Provider API allows ISPs to integrate to the AEx Inc. platform for new order placement, customer management, etc. The API is NOT meant for direct use by the ISPs customers, the ISP is expected to provide their own interface to the end-user, with this interface connecting securely in the backend with the API.

NOTE See the Getting Started section for details on how to sign-up to get a valid token to use the API.

• Customer Management
• Location Management
• Order Placement
• Service Management
• Work Order Tracking

General Error Handling

All endpoints are only accessible with a valid Bearer token that the ISP receives from AEx Inc.

• If a token is not provided, then all endpoints shall return an error with the HTTP 401 status code.
• If a token is provided, but its holder is not allowed to access an endpoint, then an error with HTTP 403 status code shall be returned.
• If a call to an endpoint fails as a result of a caller validation error, then an error with HTTP 400 status code shall be returned.