About This Guide

The Cisco Prime Fulfillment API Programmer Guide describes APIs that are available to third party Operations Support System (OSS) products. The Prime Fulfillment API provides a mechanism for inserting, retrieving, updating, and removing data from the Prime Fulfillment servers using an eXtensible Markup Language (XML) interface.

This preface contains the following sections:

•Who Should Use This Book

•How This Book Is Organized

•Related Documentation

•Additional Information

•Obtaining Documentation and Submitting a Service Request

Who Should Use This Book

This guide is intended to be a technical resource for application developers who want to use the Prime Fulfillment APIs to provision network services.

You should have an advanced level of understanding of Internet network design, operation, and terminology, be familiar with Cisco Internetwork Operating System (IOS) software and its commands, and have a basic understanding of the Cisco Prime Fulfillment product.

Service provider developers that use the API should also have an understanding of a high-level programming language such as Java, or an equivalent language. Additionally, we recommend that you have knowledge of the following:

•Hypertext Transport Protocol (HTTP/HTTPS)

•Socket programming

•XML and XML Schema

You should be familiar with the Prime Fulfillment GUI and how to use it to provision your network. In most cases, API operations correlate to GUI operations. See Appendix A, "GUI to API Mapping," for more information.

How This Book Is Organized

This programmer guide is organized as follows:

•These chapters describe the Prime Fulfillment API fundamentals.

–Chapter 1, "Introduction to the Prime Fulfillment API," describes the fundamental concepts for using the API XML, and includes the API model, components, and operations.

–Chapter 2, "Getting Started," describes the steps required to log into the API, and the basic steps for creating inventory, service requests, and service policies.

–Chapter 3, "Common APIs," describes the APIs for operations that are common to all Prime Fulfillment services.

–Chapter 4, "Using Templates," describes Prime Fulfillment templates and how to use them to download configurations and use them in a service request.

–Chapter 5, "Monitoring APIs," describes how to use the API to monitor services and create reports.

•These chapters describe the concepts for each service and provide a provisioning example, which includes the steps required to provision the services using the Prime Fulfillment APIs.

–Chapter 6, "MPLS Provisioning"

–Chapter 7, "L2VPN Provisioning"

–Chapter 8, "VPLS Provisioning"

–Chapter 9, "FlexUNI/EVC Provisioning"

–Chapter 10, "Traffic Engineering Management Provisioning."

•Additional information:

–Appendix A, "GUI to API Mapping," maps the GUI operations to the corresponding APIs.

–Appendix B, "Implementing a Notification Server," provides an example for implementing a servlet to receive notification events from Prime Fulfillment, and lists all events that can be collected for notification.

–Appendix C, "Scripts," provides the list of scripts available with the Prime Fulfillment software application.

–Appendix D, "Prime Fulfillment XDE SDK," Gives an overview of the XDE SDK, how to install it, and how to use it to extend the functionality of Prime Fulfillment.

Related Documentation

The entire documentation set for Cisco Prime Fulfillment, can be accessed at:

http://www.cisco.com/en/US/products/ps11664/tsd_products_support_series_home.html

or at:

http://www. cisco.com/go/fulfillment

The following documents comprise the Cisco Prime Fulfillment 6.1 documentation set:

General Documentation (in suggested reading order)

•Cisco Prime Fulfillment Getting Started and Documentation Guide 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/roadmap/docguide.html

•Release Notes for Cisco Prime Fulfillment 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/release/notes/relnotes.html

•Cisco Prime Fulfillment Installation Guide 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/installation/guide/installation.html

•Cisco Prime Fulfillment User Guide 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/user/guide/prime_fulfill.html

•Cisco Prime Fulfillment Theory of Operations Guide 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/theory/operations/guide/theory.html

•Cisco Prime Fulfillment Third Party and Open Source Copyrights 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/third_party/open_source/copyright/Prime_Fulfillment_Third_Party_and_Open_Source_Copyrights61.pdf

API Documentation

•Cisco Prime Fulfillment API Programmer Guide 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/developer/guide/apipg.html

•Cisco Prime Fulfillment API Programmer Reference 6.1

http://www.cisco.com/en/US/docs/net_mgmt/prime/fulfillment/6.1/developer/reference/xmlapi.zip

Note All documentation might be upgraded over time. All upgraded documentation will be available at the same URLs specified in this document.

Additional Information

•For Tomcat web server:

http://jakarta.apache.org/tomcat/index.html

•For SOAP plug-in:

–http://xml.apache.org/soap/

•For XML and XML Schema

–http://www.w3.org/XML

–http://www.w3.org/TR/xmlschema-0/

•For events and notifications through the CIM event model

http://www.dmtf.org/standards/documents/CIM/DSP0107.pdf

•For CIM Objects over HTTP, DMTF

http://www.dmtf.org/standards/documents/WBEM/DSP200.html

Obtaining Documentation and Submitting a Service Request

For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.