Quick Start Guides
Get up and running quickly with our comprehensive integration guides.
Loading guides...
User Journey
Your Personalized API Access Map
This page shows everything you need to integrate with the Ecites Konnect API — the endpoints, webhooks, schemas, and documentation you're authorized for, as well as your recommended integration flow.
Loading User Journey...
API Specifications
This Ecites Konnect offers comprehensive information about the Ecites Konnect Specifications, designed to facilitate seamless interactions with various systems and services. It includes an in-depth description of the different API endpoints, outlining their respective parameters, expected request and response formats, and examples for clarity.
Loading APIs...
The entire Ecites Konnect has been meticulously developed in accordance with OpenAPI Standards
ensuring consistency, security, and ease of integration. This portal serves as a vital resource for developers and integrators to effectively utilize the Ecites Konnect.
Loading endpoints...
Loading webhooks...
Loading schemas...
Playground Simulator
Interactive API playground to test requests and view responses in real-time.
Setting up Playground Simulator...
Setting up Playground Simulator...
Integration Examples
Ready-to-use snippets in multiple languages.
Test Data & Resources
Use these sample resources and test data sets to validate your integration.
Filter Test Data
Practical Use-cases
Common integration scenarios and implementation patterns for this endpoint.
Filter Use-cases
Active Token
Use this when testing requests in external tools like Postman or curl.
No active token. Please log in to view your session token.
Security
We are committed to ensuring peace of mind for all integration partners regarding security and encryption. We conduct regular audits and utilize best-in-class security tools and practices to maintain a high level of security.
Secure Connections
iRIMS enforces HTTPS for all services, utilizing TLS 1.2+ (SSL) to secure connections across all public-facing websites.
Continuous Security Audits
We consistently audit our solutions through penetration testing, code analysis, and evaluating certificates and cipher strength to protect our data.
Authentication
This API uses Bearer Token Authentication. Every request must include a valid token in the Authorization header.
Active Bearer Token
Created on verification of your credentials.
Live Session
YOUR ACCESS TOKEN
••••••••••••••••••••••••
Authentication Simulator
This endpoint is used to generate a Bearer token required for authentication across all API endpoints in the portal. The token returned from this endpoint must be included in the Authorization header of every API request as a Bearer token.
Setting up Authentication Simulator...
Setting up Authentication Simulator...
Errors & Exceptions
iRIMS uses conventional HTTP response codes to indicate the success or failure of an API request:
- Codes in the 2xx range indicate success.
- Codes in the 4xx range indicate an error with the information provided.
- Codes in the 5xx range indicate an error with iRIMS.
HTTP Status Codes
200
OK
Everything worked as expected.
400
Bad Request
Validation error or missing parameters.
401
Unauthorized
Bearer Token is invalid or missing.
404
Not Found
The requested resource does not exist.
429
Throttled
Request rate limit exceeded. Slow down.
500
Server Error
Something went wrong on the iRIMS server.
Error Response Example
Authentication — Invalid Credentials (401 Unauthorized)
{
"success": false,
"message": "Unauthenticated Access Token!! Your Access Token could not be verified."
}Go-Live Preparation & Checklist
This section outlines the critical steps required for a successful production "Go-Live". Follow this structured path to ensure technical readiness, security compliance, and operational stability.
1 Governance & Formal Approvals
Before Go-Live, the following must be completed:
- Signed Memorandum of Understanding (MoU) or Contract
- Signed Service Level Agreement (SLA)
- Data Sharing & Confidentiality Agreement
- Security & Compliance Approval
- Appointment of Focal Persons (Technical, Business, Escalation)
Go-Live cannot proceed without documented approval from both parties.
2 Technical Readiness Checklist
Environment
- Production URLs configured
- SSL certificates installed and valid
- IP whitelisting & Firewall rules
- Production API credentials issued
API Readiness
- Endpoints tested in production env
- Auth mechanisms verified (OAuth2/JWT)
- Logging enabled (Req & Resp)
- Timeout and retry logic configured
Security Validation
- HTTPS enforced & Payload encryption
- Digital signature validation working
- Vulnerability assessment completed
- Data protection compliance confirmed
3 Testing Requirements
| Test Phase | Description & Success Criteria |
|---|---|
| System Integration (SIT) | End-to-end transaction flow validated. API request it response validation. Exception handling verified. |
| User Acceptance (UAT) | Business scenarios executed successfully. Realistic transaction scenarios tested. Approval from stakeholders obtained. |
| Edge Case Testing | Invalid requests, duplicate transactions, timeout scenarios, and partial data submissions handled gracefully. |
| Reconciliation | Tested daily reconciliation process and transaction matching (if financial integration). |
4 Operational Readiness
- Monitoring dashboards & Alerts (Email/SMS)
- Support escalation matrix approved
- Incident management process defined
- DR and Backup procedures confirmed/tested
5 Data Migration
- Migration plan approved
- Historical data verified
- Legacy systems freeze plan defined
- Data validation completed
6 Go-Live Strategy
🔴 Big Bang
All traffic switched to Production at once.
All traffic switched to Production at once.
🟢 Phased Rollout (Recommended)
Gradual activation of modules, users, or volume.
Gradual activation of modules, users, or volume.
7 Go-Live Day Activities
- Activate Production credentials & endpoints
- Disable sandbox endpoints
- Enable monitoring tools & Notify stakeholders
- Perform first live transaction test (Smoke Test)
- Confirm successful transaction logging
8 Post Go-Live Monitoring
Stabilization Period: 1–2 weeks
API Availability
Transaction Success Rate
Callback Success Rate
System Performance
9 Support & SLA Framework
| Issue Type | Responsible Party | Resolution SLA |
|---|---|---|
| API downtime | System Owner | 1 hour |
| Transaction failure | Integration Partner | 2 hours |
| Data mismatch | Joint Investigation | 24 hours |
| Security incident | Security Teams | Immediate |
10 Formal Go-Live Sign-Off
A formal Go-Live Sign-Off document must be archived confirming technical readiness, security compliance, UAT completion, and monitoring setup.
Ready for Production
Frequently Asked Questions
No FAQs Found
We couldn't find any FAQs matching your search criteria.
Loading FAQs...
Technical Specifications
Detailed technical documentation and specification files for deep integrations.
Loading specifications...
Test Case Templates
Standardized templates for carrying out various test cases during integration.
Loading templates...
Account Settings
Manage your portal credentials and secure your account.
Loading user accounts...
Business/Organization Accounts coming soon
Manage the business and organization profiles linked to your account from here.
Support Tickets
Loading tickets...
Notifications
Manage your notifications and stay updated with important information
Total Notifications
0
Unread
0
Read
0
Archived
0
Filters & Search
Loading notifications...
Reports & Analytics
Monitor API usage trends, performance metrics and call history.
FILTER REPORTS
Tip: For detailed payload inspection, visit the full API Audit Trail tab.
| # | Date | Endpoint | Method | Status | Response Time | IP Address |
|---|---|---|---|---|---|---|
|
Loading...
|
||||||
API Activity
Monitor inbound requests and outbound calls across all your accessible endpoints.
-
Total Requests
-
Successful (2xx)
-
Client Errors (4xx)
-
Server Errors (5xx)
FILTER INBOUND LOGS
| # | Timestamp | Method | Endpoint | IP Address | Status | Duration | |
|---|---|---|---|---|---|---|---|
| Loading... | |||||||
-
Total Calls
-
Successful (2xx)
-
Client Errors (4xx)
-
Server Errors (5xx)
FILTER OUTBOUND LOGS
| # | Timestamp | Method | Endpoint | Status | Duration | |
|---|---|---|---|---|---|---|
| Loading... | ||||||
Message Center
Reach your customers instantly with SMS, WhatsApp messages and emails. Send reminders, notifications, alerts, promotions and more in just a few clicks, with AI to help you craft the perfect message.
Single / Bulk Message
Custom Message from Excel / CSV
×
Drag & drop your file here, or browse
Supports .XLSX, .XLS, .CSV
Excel / CSV file formats:
Here is a Sample Excel file: custom_excel_template.csv
Below is a preview of how the excel (or CSV) file should look like. Ensure the Mobile numbers column has some valid numbers.
| A | B | C | D | E | F | |
|---|---|---|---|---|---|---|
| 1 | Phone | Full Names | Loan Type | Principal Amount | Balance | Due Date |
| 2 | 722000000 | John Joe | Mortgage | 10,000,000 | 1,234,675 | 13/04/2020 |
| 3 | 777070000 | Mary | Mobile Loans | 75,000 | 2323.56 | 23/03/2020 |
| 4 | 254734297926 | Long Number | Car Purchase | 1,875,000 | 234,876 | 01/10/2019 |
| 5 | ||||||
| 6 |
-
Total Sent
-
Delivered
-
Pending
-
Failed
FILTER WHATSAPP MESSAGES
| # | Timestamp | Channel | Recipient | Content | Status | Cost | |
|---|---|---|---|---|---|---|---|
| Loading... | |||||||
-
Total Sent
-
Delivered
-
Pending
-
Failed
FILTER EMAIL MESSAGES
| # | Timestamp | Channel | Recipient | Content | Status | Cost | |
|---|---|---|---|---|---|---|---|
| Loading... | |||||||
-
Total Sent
-
Delivered
-
Pending
-
Failed
FILTER HYBRID MESSAGES
| # | Timestamp | Channel | Recipient | Content | Status | Cost | |
|---|---|---|---|---|---|---|---|
| Loading... | |||||||
Message Templates
Create and manage reusable SMS, WhatsApp and Email templates for your Message Center broadcasts.
Loading templates...
Document Repository
Store and manage reusable documents such as guides, contracts and attachments for your Message Center broadcasts.
Loading documents...
Contacts
Individual people you can reach out to by SMS, WhatsApp or email.
Contact Groups
/
Group
Loading contacts...
PASTE CONTACT(S)
×
×
Data Format:
One contact per line. Start with the full name, then add a phone number and/or an email, each separated by a hash (#). A name plus at least one of phone or email is required.
John Owen # 0712 000 000
John Owen # john@example.com
John Owen # 0712 000 000 # john@example.com
UPLOAD CONTACT(S) FROM EXCEL / CSV
×
Drag & drop your file here, or browse
Supports .XLSX, .XLS, .CSV
Excel / CSV file formats:
Here is a Sample Excel file: contact_template.csv
One contact per row: a Full Name, then a Phone Number and/or an Email, each in its own column. A name plus at least one of phone or email is required.
| A | B | C | |
|---|---|---|---|
| 1 | Full Name | Phone Number | |
| 2 | John Owen | 0712 000 000 | |
| 3 | John Owen | john@example.com | |
| 4 | John Owen | 0712 000 000 | john@example.com |
| 5 | |||
| 6 |
OR
| A | B | C | |
|---|---|---|---|
| 1 | Full Name | Phone Number | |
| 2 | John Owen | 0712 000 000 | |
| 3 | Mary Wanjiku | 0722 000 000 | |
| 4 | Peter Kamau | +254 733 000 000 | |
| 5 |
LOAD CONTACT(S) FROM A SAVED FILE
×
×
Files saved to the Document Repository as contact lists.
Saved contact files
Pick a file you previously uploaded. It is imported the same way: one contact per row — a Full Name plus a valid Phone Number or Email.
Select a saved file on the left to preview it here before importing.
Contact Groups
Organize contacts into groups you can message together in a broadcast or campaign.
Loading groups...
Blacklist
Phone numbers your broadcasts and campaigns must never send to.
Loading blacklist...
Wallets
View your account balance and manage top-ups.
Loading wallets...
Get Invoice
Generate and download invoices for your account.
Get Invoice coming soon
Invoice generation and downloads will appear here.
Dashboard & Analytics
A snapshot of your messaging activity and account health.
Dashboard & Analytics coming soon
Key metrics and account analytics will appear here.
Reports and Activities
Detailed reports and a log of activity on your account.
Reports and Activities coming soon
Detailed reports and activity history will appear here.
Engagement Calendar
Track UAT sessions, go-live dates, and integration milestones.
Upcoming Events
Engagement List
| Date | Title | Type | Status | Outcome Notes |
|---|
Insights & Articles
Stay informed with the latest updates, best practices, and developer stories from the iRIMS Integration Ecosystem. Our insights cover API integration tips, platform announcements, and technical deep dives to help you build better integrations.
Changelog
Loading changelog...
→
Semantic Diff
Computing diff...
...More
Recommended Insights
SDK Generator
Generate Client SDKs
Automatically generate production-ready client libraries from our OpenAPI specification. Choose your preferred programming language below and download a ready-to-use SDK with strongly typed models, API client classes, and comprehensive documentation.
How It Works
1
Choose Language
Select your preferred programming language from the grid below.
2
Generate
Click "Generate SDK" to create a complete client library from our API spec.
3
Download
Download the generated ZIP and integrate it into your project.
4
Integrate
Follow the included README for installation and usage instructions.
Select Language
PHP
Python
Java
C# (.NET)
JavaScript
TypeScript
Go
Ruby
Swift
Kotlin
Select a language above to get started
SDK Package
Ready to downloadCode Samples
Ready-to-Use Snippets
Browse automatically generated code samples for every API endpoint. Select your preferred programming language, copy the snippet, and instantly use it in your application.
Loading API endpoints...
Comments