PSA Integration APIs Overview
N-central's Professional Services Automation (PSA) Integration APIs enable seamless integration between N-central and your PSA platforms. These APIs support both standard PSA systems like Tigerpaw and custom PSA implementations, allowing you to validate credentials and manage tickets programmatically.
Available Endpoints
Standard PSA Endpoints
GET /api/standard-psa
- List all standard PSA-related links and capabilitiesPOST /api/standard-psa/{psaType}/credential
- Validate credentials for a standard PSA system
Custom PSA Endpoints
GET /api/custom-psa
- List all custom PSA-related linksGET /api/custom-psa/tickets
- List custom PSA tickets related linksPOST /api/custom-psa/tickets/{customPsaTicketId}
- Retrieve detailed ticket information
Each endpoint is designed for specific PSA integration tasks with appropriate authentication and rate limiting controls.
API Methods
Standard PSA Integration
Manage connections and validate credentials for standard PSA systems like Tigerpaw. This endpoint provides a foundation for establishing secure connections between N-central and your PSA platform.
Key Parameters
- psaType: The type of PSA system (currently supports Tigerpaw (3))
- psaUsername: Username for PSA system authentication
- psaPassword: Password for PSA system authentication
Authentication Requirements
- Requires a valid API-Access Token
- Token must be included in the Authorization header
- Format:
Bearer <ACCESS_TOKEN>
Custom PSA Ticket Management
Create, retrieve, and manage tickets within custom PSA implementations. This endpoint allows for detailed ticket tracking and management outside of standard PSA systems.
Key Parameters
- customPsaTicketId: Unique identifier for the PSA ticket
- username: PSA system username
- password: PSA system password
Ticket Status Types
- CREATE_TICKET_CREATED_IN_NCENTRAL: Ticket successfully created in N-central
- Additional status types available based on your PSA implementation
Key Features
Standard PSA Integration
Provides dedicated endpoints for major PSA systems with built-in validation:
- Specialized support for Tigerpaw (PSA Type 3)
- Credential validation with detailed response feedback
- Integration-specific error handling and status codes
- Supports both private and public integration keys
Custom PSA Ticket Management
Comprehensive ticket management capabilities for custom PSA implementations:
- Detailed ticket information retrieval
- Support for custom ticket IDs and status tracking
- Rich ticket metadata including creation dates and titles
- Flexible ticket detail customization
Rate-Limited Protection
Built-in safeguards to ensure system stability and reliable performance:
- Automatic rate limiting on all endpoints
- 429 status codes for exceeded limits
- Clear response headers for limit tracking
- Built-in retry mechanism support
Implementation Example
Validating PSA Credentials
POST /api/standard-psa/3/credential
Authorization: Bearer <YOUR_ACCESS_TOKEN>
Content-Type: application/json
{
"username": "[email protected]",
"password": "psaPassword123"
}
Response Example
{
"data": {
"isPsaCredentialsValid": true
},
"_links": {}
}
Updated 6 days ago