SDKs and Tools

SDKs

Official SDKs are available for Python, Node.js, and Java to simplify integration with the Ethiopian Platform API.

Installation

• Python:

  pip install birr-connect-sdk

• Node.js:

  npm install birr-connect-sdk

• Java: Add the following to your pom.xml for Maven:

  <dependency>
    <groupId>com.birr-connect</groupId>
    <artifactId>birr-connect-sdk</artifactId>
    <version>1.0.0</version>
  </dependency>

Example Usage

Python

from birr-connect import birr-connect
 
client = birr-connect(api_key="YOUR_API_KEY")
transactions = client.transactions.get(account_id="acc123", start_date="2025-01-01")
print(transactions)

Node.js

const { birr-connect } = require("birr-connect-sdk");
 
const client = new birr-connect({ apiKey: "YOUR_API_KEY" });
async function getTransactions() {
  const transactions = await client.transactions.get({
    accountId: "acc123",
    startDate: "2025-01-01",
  });
  console.log(transactions);
}
getTransactions();

Java

import com.birr-connect.birr-connectClient;
 
public class Main {
  public static void main(String[] args) {
    birr-connectClient client = new birr-connectClient("YOUR_API_KEY");
    TransactionsResponse transactions = client.transactions().get("acc123", "2025-01-01");
    System.out.println(transactions);
  }
}

API Explorer

The API Explorer is an interactive browser-based tool for testing API endpoints.

Features

• Input Parameters: Easily configure query parameters, headers, and request bodies.
• View Responses: Inspect JSON responses in a formatted view.
• Debug Errors: Detailed error messages and status codes for troubleshooting.

Access the API Explorer at: https://api.birr-connect.com/explorer

Postman Collection

A downloadable Postman collection is available with pre-configured API requests for all endpoints.

Instructions to Import

1. Download the collection from https://api.birr-connect.com/postman-collection.json.
2. Open Postman and click Import in the top-left corner.
3. Select the downloaded JSON file and click Open.
4. Set up an environment in Postman with your YOUR_API_KEY variable for authentication.
5. Run requests directly from the collection.

CLI Tool

The Ethiopian Platform CLI tool provides a command-line interface for quick API interactions.

Installation

npm install -g birr-connect-cli

Example Commands

• Check account balance:

  birr-connect-cli balance --account-id acc123

• Fetch transactions:

  birr-connect-cli transactions --account-id acc123 --start-date 2025-01-01

Configuration

Set your API key:

birr-connect-cli config set --api-key YOUR_API_KEY

For more commands, run:

birr-connect-cli --help