Getting Started with Kira API
Overview
This section covers the basics of getting started with the Kira API, including authentication and general concepts.
Prerequisites
Before you begin, you'll need:
- Client ID - UUID provided by Kira
- Password - Secret password provided by Kira
- API Key - API key provided by Kira
Contact Kira support to obtain your credentials.
Quick Start
1. Authentication
Learn how to authenticate with the Kira API and obtain access tokens.
Key topics:
- Obtaining access tokens
- Using Bearer tokens and API keys
- Token expiration and refresh
- Security best practices
2. Base URLs
| Environment | Base URL |
|---|---|
| Production | https://api.balampay.com |
| Sandbox | https://api.balampay.com/sandbox |
3. Required Headers
All API requests (except /auth) require:
Authorization: Bearer YOUR_ACCESS_TOKEN
x-api-key: YOUR_API_KEY
Content-Type: application/json # For POST/PUT requests4. Authentication Example
# Authenticate
curl --location 'https://api.balampay.com/auth' \
--header 'Content-Type: application/json' \
--header 'x-api-key: YOUR_API_KEY' \
--data '{
"client_id": "your-client-id",
"password": "your-password"
}'
# Response
{
"access_token": "eyJhbGci...",
"token_type": "Bearer",
"expires_in": 3600
}Next Steps
After authentication, you can:
- Manage Users - Create and manage users
- Create Virtual Accounts - Set up virtual accounts for users
- Set up Webhooks - Receive real-time notifications
Support
- Email: [email protected]
- Documentation: Browse the guides in each section
- API Reference: See the Quick Reference
Updated 12 days ago
