Skip to content

A simple fintech api, for a multi-currency crowdfunding based platform built with Node.js and MySql

License

Notifications You must be signed in to change notification settings

Olatisunkanmi/CrowdFund-Me

Repository files navigation

CrowdFundMe API Readme

Welcome to the CrowdFundMe API documentation! This API serves as the backend for a versatile and user-friendly crowdfunding platform, allowing you to create, manage, and interact with crowdfunding campaigns seamlessly. Whether you're a developer integrating our API into your application or a curious user wanting to understand the technical aspects, this readme will guide you through the process.

Table of Contents

Introduction

CrowdFundMe API provides developers with the tools to create, manage, and interact with crowdfunding campaigns in a seamless and efficient manner. With multi-currency support and the ability to create virtual accounts for fund transfers, our API aims to simplify the crowdfunding experience for both creators and backers.

Key Features

  • Multi-Currency Support: Campaign creators can set up crowdfunding projects in different currencies, allowing backers from around the world to contribute conveniently.

  • Virtual Accounts: Users can create virtual accounts associated with their campaigns to receive transfers and manage funds securely.

Getting Started

To start using the CrowdFundMe API, follow these steps:

  1. Sign Up: Create an account on our platform to obtain API credentials.
  2. Authentication: Acquire an API key to authenticate your requests.
  3. Explore Endpoints: Review the available API endpoints and their functionalities.
  4. Make Requests: Make HTTP requests to interact with the API and create/manage crowdfunding campaigns.
  5. Handle Responses: Process the API responses according to your application's requirements.

Authentication

To authenticate your requests, include your API key in the headers of your HTTP requests:

About

A simple fintech api, for a multi-currency crowdfunding based platform built with Node.js and MySql

Resources

License

Stars

Watchers

Forks