Northbound API Documentation

Introduction

Welcome to the Northbound API project documentation. This guide provides a complete reference for integrating carrier and xSP back‑office systems with the Friendly Northbound API. It covers:

  • Project goals and business benefits

  • Setup and deployment instructions

  • System and component architecture

  • Database configuration and schema design

  • Testing strategy and coverage requirements

  • API specifications, authentication, and integration endpoints

  • Error handling and security considerations

Project Overview

The Northbound API enables service providers to integrate parameter transmission and provisioning operations directly into their OSS, billing, and CRM systems. By leveraging SOAP and REST interfaces, the API allows:

  • Automated, immediate provisioning of new customer services by updating device configurations

  • Reduced support‑call handling time through retrieval of current device settings for CSRs

  • A reliable mapping between user IDs and device serial numbers for asset tracking

External systems—such as CRM, OSS, and billing—invoke the SOAP web service, supplying all necessary parameters for provisioning, device queries, and status checks. The ServerWS endpoint processes these requests and returns structured Success/Fail responses with error codes where applicable.

Contents