Staging Environment Configuration

This environment is used for testing and staging Cladfy Member API integrations before moving to production.

Use this setup to simulate the full Member journey (authentication, profile, loan applications, repayments) with test credentials and sandbox data.

🔑 API Keys

📘

Authentication

All calls to the endpoints will require an API Key in the Header provided as X-API-Key: YOUR_API_KEY, which you can get from your dashboard in the branches settings section or upon request via email to [email protected]

Where to find your API Keys

On your dashboard go to the branches settings section, click the actions button of any particular branch, then navigate to Manage API.

📘

Base URL

All endpoints will be appended to this URL https://{appname}.cladfy.app/api/ or your localhost.

Replace with your local or staging server URL when running tests

Variable	Description	Example	Type
api_key	Public API key identifying your branch/app	pk_test_sample_key	Secret
api_secret	Private API secret for your branch	sk_test_sample_secret	Secret

Usage example (in headers):

Bash

-X 'X-API-Key: pk_test_sample_key' \
-X 'X-API-Secret: sk_test_sample_secret'

🧍‍♂️ Member Variables

Variable	Description	Example
member_id	Member unique ID	1
member_no	Member number assigned after registration	MEM-0001
jwt_token	JWT token received after login	eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
token_type	Token type (bearer)	bearer

💰 Loan & Payment Variables

Variable	Description	Example
loan_id	Unique ID for the active loan	10
loan_number	Loan reference number	LN-00010
loan_product_id	Product ID for testing	1
account_id	Linked savings account ID	1
payment_id	Payment reference ID	(auto-filled after payment)
transaction_id	Payment transaction ID	(auto-filled)
trx_id	Mobile money transaction ID	(auto-filled)
disbursement_trx_id	Disbursement transaction reference	(auto-filled)

⚙️ Setup Instructions

1. Open Postman → Environments → Import
2. Upload Staging.postman_environment.json
3. Select Staging/Test environment from the top-right dropdown
4. Ensure base URL is accessible locally (e.g., php artisan serve)
5. Test using endpoints from Complete Member API (Production Ready) collection

🧩 Example: Local Login Request (cURL)

Bash

curl -X POST https://{appname}.cladfy.app/api/auth/login \
-H 'X-API-Key: pk_test_sample_key' \
-H 'X-API-Secret: sk_test_sample_secret' \
-H 'Content-Type: application/json' \
-d '{
  "email": "[email protected]",
  "password": "SecurePass123!"
}'

✅ Expected Response

JSON

{
  "success": true,
  "message": "Login successful",
  "data": {
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOi...",
    "token_type": "bearer",
    "expires_in": 3600,
    "member": {
      "id": 1,
      "member_no": "MEM-0001",
      "first_name": "John",
      "last_name": "Doe"
    }
  }
}

❗️

Note

This environment is meant for sandbox use only. Do NOT use production API keys or data.