Calix Partner Community: Developer Resource Guide

Congratulations on becoming a Calix Partner. This guide is designed to help you access Calix Developer resources quickly and easily. Many of these resources require MyCalix access. Please be sure to login to MyCalix before following these links. See the end of this document for information about registering for a MyCalix account.

Resources: Click or scroll for information and a link to access each resource.

CALIX DEVELOPER RESOURCES

SMX HELP RESOURCES

GETTING STARTED WITH THE SMX API INTERFACE, R22.X
USING THE AXOS SANDBOX, CALIX APPLICATION NOTE
CALIX MANAGEMENT SYSTEM (CMS) R15.X NORTHBOUND INTERFACE API GUIDE
TACTV: USING POSTMAN TO INTERACT WITH CMS NBI
CALIX CLOUD APIS - TOKEN MANAGEMENT
TACTV: CALIX CLOUD API - TOKEN MANAGEMENT
CALIX CLOUD APIS - TRAFFIC USAGE INSIGHTS
REVENUE EDGE: TECHNICAL DOCUMENTATION
HOW TO REGISTER FOR MY CALIX

Calix Developer Resources

Calix has collected all its product API documentation and related technical references in one location, to make it easy for developers and integrators to locate information helpful for programming.

Calix Developer Portal

The Calix Cloud developer portal manages application registration, application approval, and obtaining tokens necessary to access the APIs. OAuth 2.0 access tokens are issued on a per organization, per application registration basis.

Calix Developer Portal Introduction

This site provides an overview of how-to login and use the developer portal.

Calix Developer Portal - Get Started

Guide to help Accelerate the creation of your products and services.

SMx Help Resources

AXOS Services Management Connector (SMx)

This site provides quick links to these and other resources:

The SMx System Administration Guide which covers SMx server installation, software upgrades, and other network management tasks.
The SMx Service Management Guide covers everything you need to know about configuring subscriber access services on AXOS systems
The Getting Started with the SMx API Interface shows how to use the Northbound API (Swagger) interface, integrated in the SMx software, to view SMx RESTful APIs.

Getting Started with the SMx API Interface, R22.x

This downloadable document describes the basis of how to use the AXOS SMx Northbound Interface API web services.

Intended Audience: This document is intended for provider and provider OSS vendor developers who are integrating AXOS SMx into provider back-office OSS and BSS systems to provide service lifecycle management. This document assumes that the user's PC is equipped with a supported web browser (Internet Explorer or Firefox) and that the user is familiar with using a web browser and a command-line interface over a standard telnet or console connection. Familiarity with datacom, telecom, and standards-based Ethernet technologies and conventions is recommended.

Using the AXOS Sandbox, Calix Application Note

This Application Note describes how to download and install an AXOS Sandbox module and connect to that module via the CLI, Web GUI, SSH and Calix SMx (previously known as Activate). For more information about how to provision AXOS software refer to the Calix AXOS SMx System Management Guide and the Turn Up and Transport Guide for AXOS software.

Calix Management System (CMS) R15.x Northbound Interface API Guide

This document describes how to use the CMS XML NBI for systems management integration to an OSS. Operators can use their OSS to manage Calix network elements via the CMS NBI adapter without significant code development per system. This document describes how to integrate to the CMS XML NBI for provisioning of Calix E7 EXA access systems and Calix AE ONTs.

tacTV: Using Postman to Interact with CMS NBI

This video shows how to use a tool to test CMS XML API calls to E7 nodes. Click the video to play.

Calix Cloud APIs - Token Management

This article provides an overview of the new OAuth 2.0, token-based, authentication structure we have implemented for our Calix Cloud APIs.

tacTV: Calix Cloud API - Token Management

This tacTV covers the token management process for the new Calix Cloud API.

Calix Cloud APIs - Traffic Usage Insights

Within both Calix Support Cloud (CSC) and Calix Operations Cloud (CCO), you may see the option to view "Traffic Reports" for your subscribers. This data is based on "Flow" (ex. Netflow, sFlow, IPFIX, etc.) data that you send to us from the core equipment in your network. This API allows you to review this same data and integrate or review it as desired.

This site includes articles about interacting with the new Calix Cloud APIs, and authenticating your requests within the new OAuth 2.0 model.

Revenue EDGE: Technical Documentation

This site includes provides a guided view to technical documentation on latest features and enhancements available in the current Calix Cloud software release.

How to register for My Calix

My Calix is our portal for customers and partners. It provides access to an array of resources to help you accelerate your success and solve business needs.

Who needs a MyCalix account?

Each person who is regularly interacting with Calix should create a Calix account.

What is involved in registration?

Complete the registration form using your work email address, indicating that your user type as "Partner/Affiliate." Your information will be verified against our Salesforce listings for your company. If access is denied, please contact your partner manager, we may need to add the requester to your company's partner records.

	Calix Remote Network Turn-up and Test Service Description This document outlines the Calix Professional Services offering for remotely turning up and testing a new Calix Layer 2 Node. It details the scope of work, test plan, and requirements for the service, including grounding, power, optical readings, uplink protection, alarming, and management channel verification.
	Calix CMS 12.0: Managing Your Network Transformation This document outlines the features and benefits of Calix CMS 12.0 for managing network transformation, including service provisioning, network integration, and migration strategies for various Calix platforms.
	Calix DPx-R21.3.1 Release Notes: New Features, Enhancements, and Resolved Issues This document details the new features, enhancements, and resolved issues in Calix DPx-R21.3.1, including support for various AXOS and ONT systems, provisioning capabilities, and interoperability with other Calix products. It also outlines known issues and troubleshooting tips.
	Calix SMx: Accelerating Broadband Service Delivery with AXOS Explore Calix SMx, a next-generation service delivery and assurance platform for AXOS systems, enabling automated, dynamic service operations for service providers. Learn about its architecture, features, and system requirements.
	Calix Systems Management Integration Guide for Brightspeed This guide details the integration of Calix Systems Management (SMx) and Calix Cloud with Brightspeed's network for service lifecycle, assurance, and fault management. It covers API conventions, provisioning, service creation, modification, deletion, and performance monitoring.
	Calix E7-2 AXOS GE-24 r2 Data Sheet: High-Density Ethernet Aggregation Detailed data sheet for the Calix E7-2 AXOS GE-24 r2 line card, featuring 24 GE CSFP ports and 10GE uplinks for high-density Ethernet aggregation, IPTV, and resilient network transport.
	Operationalizing Calix Revenue Edge: GigaSpire Turn-Ups with Calix Support Cloud A step-by-step guide for operationalizing Calix Revenue Edge, detailing the process of repeated GigaSpire turn-ups using Calix Support Cloud. The guide covers initial setup, configuration, and subscriber management.
	Introduction to GigaSpire BLAST Systems eLearning Course Learn about the Calix GigaSpire BLAST systems, including deployment, support, and extending wireless networks with GigaMesh. This course is designed for customer support, field technicians, and network operations personnel.

Calix Partner Community

Developer Resource Guide for Partners