Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement: Update Quickstart Guide #402

Merged
merged 5 commits into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@ You can view this README in your preferred language:

Join us for a month of coding, learning, and contributing to Chimoney's open-source projects!

We have also introduced a [Quickstart Guide](submissions/Quickstart_Guide.md) to help you get started with integrating the Chimoney API into your applications.

## Chimoney Rewards

At Chimoney, we value your contributions, and to show our appreciation, we will be offering Chimoney rewards for pull requests that are successfully merged into our open-source projects.

- For every substantial merged Pull Request (PR), contributors will receive a Chimoney reward of $10, sent via email. Please note that minor contributions, such as typo fixes or other small changes, will not qualify for rewards. Some issues may have specific reward amounts, which are clearly indicated in the issue labels. The amount displayed on the label reflects the payout for those specific, more complex issues.
Expand Down
111 changes: 111 additions & 0 deletions submissions/Articles/Quickstart_Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# Quickstart Guide to Integrate Chimoney API

Welcome to the Chimoney Quickstart Guide! This guide will help you easily integrate the Chimoney API into your applications.

## Step 1: API Key Generation

To start using the Chimoney API, you need to sign up and generate an API key from the developer dashboard:

1. Go to the [Chimoney Developer Dashboard](https://dash.chimoney.io/auth/signin?next=/).
2. Sign up for an account or log in if you already have one.
3. Navigate to the "API Keys" section.
4. Click on "Generate New API Key" and save your key securely.

## Step 2: SDK Installation

Chimoney provides SDKs for popular programming languages to simplify integration. Below are instructions for installing the SDK for Node.js and Python.

### Node.js

To install the Chimoney SDK for Node.js, use npm:

```bash
npm install chimoney-sdk
```

### Python

To install the Chimoney SDK for Python, use pip:

```bash
pip install chimoney-sdk
```

## Step 3: Making a Sample Request

Here’s how to make a basic API call to initiate a payout using the Chimoney SDK.

### Node.js Example

```javascript
const Chimoney = require('chimoney-sdk');

const chimoney = new Chimoney('YOUR_API_KEY');

chimoney.payout({
amount: 100,
currency: 'USD',
recipient: 'recipient@example.com',
})
.then(response => {
console.log('Payout successful:', response);
})
.catch(error => {
console.error('Error initiating payout:', error);
});
```

### Python Example

```python
from chimoney import Chimoney

chimoney = Chimoney(api_key='YOUR_API_KEY')

response = chimoney.payout(amount=100, currency='USD', recipient='recipient@example.com')

print('Payout successful:', response)
```

## Step 4: Overview of Key Features

The Chimoney API provides several key functionalities, including:

- **Payouts**: With Chimoney’s API, you can initiate seamless payouts to over 130 countries via bank, mobile money, airtime, or even Interledger-enabled accounts.
- **Multi-Currency Wallets**: Manage balances in multiple currencies, enabling smooth cross-border payments and better control over currency exchanges.
- **Payment Requests**: Request payments from customers or clients, making invoicing and collections easier with a streamlined API integration.
- **Redemption of Value**: Offer users the ability to redeem Chimoney through options such as bank transfers, Mobile Money, gift cards, or airtime.

For more detailed information, please refer to the [API Documentation](https://chimoney.io/developers-api/).

---

## Libraries & Plugins

Chimoney offers pre-written code packages (server-side helper libraries) to make using the API easier! Below are links to some popular SDKs available in the Chimoney community:

- **Python SDK**: [Chimoney-Python](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/Chimoney-Python)
- **PHP-Laravel SDK**: [Chiconnect Laravel Web App](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chiconnect-laravel-web-app)
- **JavaScript (NPM)**: [Chimoney-JS](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chimoney-js)
- **Flutter SDK**: [Chispend Widget](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chispend_widget)

## Use Cases

Here are a few implementations of the Chimoney API built and maintained by our Chimoney Community:

- **Instant Airtime Redemption Page**: [Redeem Airtime](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chimoney-redeem-airtime)
- **Payout using Chimoney Twitter Bot**: [Chisend](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/Chisend)
- **Payout Gift Card**: [Gift Card Payout](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chiconnect-giftcard-payout)
- **Mobile Money Payout**: [Mobile Money Payout](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chiconnect-mobile-money-payout)
- **Bank Payout**: [Bank API Payout](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chiconnect-bank-api-payoutt)
- **Paypaddy**: [Paypaddy](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/pay-paddy)
- **Secret Santa**: [Secret Santa](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/secret-santa)
- **Chimap**: [Chimap](https://github.com/Chimoney/chimoney-community-projects/tree/main/submissions/chimap)

For more examples and resources, visit the [Chimoney Community Projects](https://github.com/Chimoney/chimoney-community-projects).

## Author

- **Brijesh Thummar**

I am Brijesh Thummar, a second-year Computer Science student graduating in 2027, with a focus on becoming a Quant Developer. I am proficient in C, Java, Rust, Scala, and Swift, and currently working on mastering algorithms, data structures, and object-oriented programming. I have experience with Java Swing, JDBC, Maven, and MySQL. I enjoy problem-solving, building software solutions, and contributing to open-source projects.
Loading