Fidectus Global Energy Network (GEN) API
Developer's guide to the GEN HTTPS API — your gateway to post-trade automation.
Welcome
Welcome to the latest Fidectus API documentation. This guide is designed to help developers and integrators connect with and make the most of GEN.
Introduction to GEN
The Fidectus Global Energy Network (GEN) is a comprehensive SaaS platform that enables post-trade automation and optimisation for OTC energy trading. Designed for developers and integrators, GEN provides multiple integration methods, allowing a gradual transition from manual processes to fully automated straight-through processing.
All requests, whether via the web application, REST API, or SFTP, are handled by the same resilient microservice-based backend infrastructure. This ensures consistency, reliability, and scalability across all integration methods.
Developer Focus: This documentation is specifically designed for technical teams implementing GEN integrations. For business users, please refer to the User Guides in our Knowledge Base.
Web Application
The GEN web application offers a full-featured interface for document management, dispute resolution, and reporting. Although built for end-users, developers integrating with GEN should understand its functionality.
Environment URLs
Staging Environment
https://staging.gen.fidectus.com Use for development and testing
Production Environment
https://gen.fidectus.com Live production environment
Key Features for Integration Testing
- Document Workflow Management: Upload, view, and track the processing status of documents.
- Real-Time Status Updates: Monitor documents submitted via API directly through the web interface.
- Dispute Resolution: Test and validate dispute-handling workflows to ensure accuracy.
- Reporting Dashboard: Verify the accuracy and completeness of API integration data.
Getting Started: Contact support@fidectus.com to request account credentials and gain access to both staging and production environments.
REST API
The GEN REST API provides comprehensive programmatic access to all platform functionality. The API follows RESTful principles and supports JSON request/response formats for seamless integration.
API Documentation Hubs
Our API documentation is organised into four main hubs, each covering specific functional areas:
Confirmation Hub
With Confirmation Hub, you can process, monitor, control, and match all your confirmations in a centralised location. The solution enables seamless connectivity with all counterparties whether they use email, PDFs, varying formats, distribution channels, or third-party vendors.
Settlement Hub
Settlement Hub provides an invoicing and netting process, enabling your team to automate the verification, processing, and reconciliation of trades and invoices. Our solution ensures accuracy, tax compliance, and adherence to e-invoicing standards.
Complete API Reference: Detailed endpoint documentation, request/response schemas, and interactive examples are available in the dedicated API documentation sections of our website.
Authentication
GEN uses a standard OAuth2 Client Credentials flow for secure machine-to-machine (M2M) authentication.
Authentication Workflow
- Obtain Credentials: Use the Client ID and Client Secret provided during onboarding.
- Request Access Token: Send a POST request to the Auth0 Authorization Server with your credentials.
- Receive Bearer Token: If the credentials are valid, the server responds with an Access Token.
- Use Token: Include the Access Token in the Authorization header of all subsequent API calls.
- Cache Token: Store the Access Token locally and reuse it until it expires (default lifetime: 24 hours).
Authentication Endpoints
Staging Environment
https://staging--fidectus.eu.auth0.com/oauth/token Production Environment
https://fidectus.eu.auth0.com/oauth/token Code Examples
Staging Environment
curl -X POST 'https://staging--fidectus.eu.auth0.com/oauth/token' \
-H 'Content-Type: application/json' \
-d '{
"client_id": "[YOUR_CLIENT_ID]",
"client_secret": "[YOUR_CLIENT_SECRET]",
"audience": "fidectus_open_api_staging",
"grant_type": "client_credentials"
}'Production Environment
curl -X POST 'https://fidectus.eu.auth0.com/oauth/token' \
-H 'Content-Type: application/json' \
-d '{
"client_id": "[YOUR_CLIENT_ID]",
"client_secret": "[YOUR_CLIENT_SECRET]",
"audience": "fidectus_open_api",
"grant_type": "client_credentials"
}'Expected Response
{
"access_token": "[YOUR_ACCESS_TOKEN]",
"expires_in": 86400,
"token_type": "Bearer"
}Using the Access Token
Include the access token in the Authorization header of all API requests:
Authorization: Bearer [YOUR_ACCESS_TOKEN]Security Best Practices
- Secure Storage: Always store your Client ID and Client Secret securely. Never expose them in client-side code, public repositories, or unsecured logs.
- Token Caching: Cache the access token and reuse it until it expires. The default lifetime is 86,400 seconds (24 hours).
- HTTPS Only: All authentication and API calls must use HTTPS to ensure encryption and data integrity.
- Token Expiration: Monitor the expires_in value in the token response and refresh tokens before they expire to maintain uninterrupted access.
Important: Client credentials are environment-specific. Staging credentials will not work in production and vice versa. The audience parameter differs between environments.
Integration Workflows
GEN currently supports a single integration method for data synchronisation: polling-based updates.
Polling Pattern
Your system regularly queries GEN API for updates
Best For:
- • Simple integration requirements
- • Systems behind firewalls
- • Batch processing workflows
- • Legacy system integrations
Implementation:
GET /api/confirmations?lastUpdateFrom={timestamp}Recommendation: Use polling for your integration.
SFTP Interface
For organisations requiring file-based integration, GEN provides a secure SFTP interface that complements the REST API. This interface is ideal for batch processing, legacy system integration, and scenarios where direct API integration isn't feasible.
SFTP Connection Details
Staging SFTP
sftp-staging.gen.fidectus.com22SFTP (SSH File Transfer Protocol)Production SFTP
sftp.gen.fidectus.com22SFTP (SSH File Transfer Protocol)Directory Structure & Usage
/in/
Upload documents for processing
- • Supported formats: XML, CSV, JSON, PDF
- • Files are automatically processed upon upload
- • Use subdirectories to organise by document type
/processed/
Successfully processed files are moved here
- • Files include processing timestamps
- • Organised by processing date
- • Includes processing summary reports
/out/
Generated reports and export files
- • Automated report generation
- • Custom export requests
- • Scheduled data extracts
/err/
Files with processing errors
- • Includes detailed error reports
- • Original files preserved for analysis
- • Error codes mapped to API responses
Integration Best Practices
- File Naming: Use consistent naming conventions with timestamps
- Atomic Operations: Upload to temporary names, then rename when complete
- Error Handling: Monitor error directory and implement retry logic
- Security: Use key-based authentication, never passwords
- Monitoring: Implement file processing status monitoring
Access Setup: SFTP access requires separate credential provisioning. Contact support@fidectus.com with your public key for account setup.
