API Documentation
Build powerful pricing applications with our comprehensive REST APIs. Full access to pricing engine, master data, AI intelligence, and more.
API Architecture
Microservices-based architecture with unified API gateway
API Capabilities
Enterprise-grade APIs designed for performance, security, and developer experience.
Enterprise Security
JWT authentication, RBAC, audit logging, and encrypted data transfer.
High Performance
Sub-100ms response times with intelligent caching and optimized queries.
Real-Time Updates
WebSocket support via SignalR for live pricing and sync notifications.
RESTful Design
Clean REST architecture with OpenAPI/Swagger documentation.
Multi-Region
Global deployment with edge caching and regional data residency.
Rich Responses
Standardized JSON responses with detailed error messages and pagination.
Quick Start Examples
Get started quickly with these code examples for common operations.
// Authentication with JWT Bearer Token
const response = await fetch('https://api.pricejoule.com/api/v1/auth/login', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: 'user@company.com',
password: 'your-password'
})
});
const { token, refreshToken, expiresIn } = await response.json();
// Use token in subsequent requests
const pricesResponse = await fetch('https://api.pricejoule.com/api/v1/prices/calculate', {
method: 'POST',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
productId: 'PROD-001',
customerId: 'CUST-001',
quantity: 100
})
});API Categories
Comprehensive APIs organized by domain for easy navigation.
Pricing Core API
250+ endpointsCore pricing engine with price calculations, what-if scenarios, and margin analysis.
/api/v1/prices/calculate/api/v1/prices/bulk-calculate/api/v1/price-lists/api/v1/scenariosMaster Data API
200+ endpointsProduct, customer, and organizational master data management.
/api/v1/products/api/v1/customers/api/v1/price-indices/api/v1/products/importConfiguration API
120+ endpointsPricing procedures, blueprints, formulas, and business rules.
/api/v1/pricing-procedures/api/v1/blueprints/api/v1/condition-types/api/v1/formulasAI & Intelligence API
80+ endpointsAI-powered pricing recommendations, predictions, and composable pricing.
/api/v1/ai/recommendations/api/v1/ai/compose/api/v1/ai/formula-generate/api/v1/ai/modelsIntegration API
150+ endpointsExternal system connectors, data feeds, and synchronization.
/api/v1/connectors/api/v1/data-feeds/api/v1/sync-plans/api/v1/field-mappingsWorkflow & Approvals API
110+ endpointsDeal desk, approval workflows, and delegation management.
/api/v1/deals/api/v1/approvals/pending/api/v1/approvals/{id}/approve/api/v1/delegationsOfficial SDKs & Libraries
Native SDKs for popular languages with full TypeScript support.
JavaScript/TypeScript
AvailableFull-featured SDK with TypeScript support
Python
AvailableAsync-ready SDK for Python 3.8+
.NET/C#
AvailableNative .NET SDK with dependency injection
Java
Coming SoonSpring Boot compatible SDK
Enterprise-Grade Authentication
JWT Bearer Tokens
Industry-standard token-based authentication with configurable expiration.
Role-Based Access Control
Fine-grained permissions with role and permission-based authorization.
API Key Support
Service-to-service authentication with rotatable API keys.
OAuth 2.0 Integration
Connect with existing identity providers via OAuth 2.0 flows.
curl -X POST https://api.pricejoule.com/api/v1/auth/login \
-H "Content-Type: application/json" \
-d '{
"email": "user@company.com",
"password": "your-password"
}'
# Response
{
"token": "eyJhbGciOiJIUzI1NiIs...",
"refreshToken": "dGhpcyBpcyBhIHJlZnJl...",
"expiresIn": 3600,
"tokenType": "Bearer"
}Ready to Start Building?
Get your API keys and start integrating PriceJoule into your applications today.