# NSPS Connector Implementation Guide

> Comprehensive guide to implement connectors between NSPS and external network systems.

## Key Concepts

- **NSPS (New Service Provisioning System)**: Processes events, enriches data, and sends them to the connector.
- **Connector**: Receives events enriched by NSPS, selects the necessary parameters, and sends them to the external system in the format required by that external system.
- **External Network Systems*: Requires updates based on the events received, with each system having its own proprietary API.

## Docs

- [Introduction](https://docs.nsps.portaone.com/index.md):
Overview of the entire provisioning system and the connector’s purpose.
- [Get started](https://docs.nsps.portaone.com/get-started/quickstart.md):
Step-by-step example of creating a simple connector in TypeScript or Python.

### Connector

- [Connector overview](https://docs.nsps.portaone.com/connector/connector-overview.md):
Overview of the connector and its key responsibilities.
- [Implementation requirements](https://docs.nsps.portaone.com/connector/implementation-specific/requirements.md):
Mandatory technical and functional requirements for the connector.
- [Request handling](https://docs.nsps.portaone.com/connector/implementation-specific/request-handling.md)
Guidelines for processing incoming HTTP requests from NSPS.
- [Response and error handling](https://docs.nsps.portaone.com/connector/implementation-specific/error-handling.md)
Recommendations for error management and sending proper responses to NSPS.
- [Configuration](https://docs.nsps.portaone.com/connector/implementation-specific/configuration.md)
Recommendations for the connector configuration, both for its own operation and for interaction with the external system.
- [Logging](https://docs.nsps.portaone.com/connector/implementation-specific/logging.md)
Logging requirements for the connector.
- [Best practices](https://docs.nsps.portaone.com/connector/implementation-specific/best-practices.md)
Guidelines for secure, reliable connector development (authorization, input validation, NSPS responses).
- [Deployment](https://docs.nsps.portaone.com/connector/deployment.md)
Instructions for cloud deployment.
- [Testing](https://docs.nsps.portaone.com/connector/testing.md)
General testing recommendations and sample test cases.

### NSPS

- [NSPS overview](https://docs.nsps.portaone.com/NSPS/nsps-overview.md)
Introduction to NSPS and its operation.

#### Data flows

- [Headers](https://docs.nsps.portaone.com/NSPS/data-flows/headers.md)
Headers sent by NSPS to the connector.
- [Event types](https://docs.nsps.portaone.com/NSPS/data-flows/event-types.md)
Detailed description of supported event types, their trigger conditions and key fields.
- [Output data structure](https://docs.nsps.portaone.com/NSPS/data-flows/output-data-structure.md)
Structure of data sent from NSPS to the connector.

## Examples

### Python

- [WTL HLR-HSS Connector](https://docs.nsps.portaone.com/examples/python/wtl-hlr-hss-connector/overview.md):
WTL HLR-HSS connector, built with Python FastAPI.
- [Simple Connector (Python/FastAPI)](https://docs.nsps.portaone.com/examples/python/simple-connector-fastapi/overview.md):
Minimal connector implemented in Python FastAPI.
- [HubSpot Contacts CRM Connector](https://docs.nsps.portaone.com/examples/python/hubspot-crm-connector/overview.md):
Compact Python/FastAPI connector for syncing NSPS events with HubSpot Contacts CRM.

### TypeScript

- [Simple Connector (TypeScript/Express)](https://docs.nsps.portaone.com/examples/typescript/simple-connector-express/overview.md):
Minimal connector implemented in TypeScript Express.
- [Zoho Crm Connector](https://docs.nsps.portaone.com/examples/typescript/zoho-crm-connector/overview.md):
TypeScript/Express connector for syncing NSPS events with Zoho CRM.

## Optional

- [NSPS technical specifications](https://docs.nsps.portaone.com/NSPS/technical-specifications.md):
NSPS technical specifications relevant for the connector implementation.