Skip to main content

​
Overview

The HelpYouSponsor API is designed to handle a wide range of tasks that are essential for managing a Non-Profit Organization. From donation tracking to sponsorship automation, this API provides all the necessary endpoints to streamline your workflow and enhance the functionality of your Non-Profit.

​
Key Features

  1. Donor Management: Manage donor accounts, monitor their sponsorships and donations, and update donor information.
  2. Sponsorship Management: Automated sponsor-recipient matching, multi-program support, and customizable sponsorship levels and durations.
  3. Data Management: Access to centralized donor and recipient database, advanced search and filtering capabilities.
  4. Donation Tracking: Monitor donations, manage donor information, and generate reports on donation activities.

​
Getting Started

To get started, generate an API key and include it in the header of every request. The API supports multiple programming languages and provides sample code for each endpoint to help you integrate quickly.

​
Authentication

Generate an API key from Settings → Account Settings → Developer Settings in the HelpYouSponsor dashboard. Include it in the X-HYS-API-Key header of every request. 
curl --request GET \
--url https://api.helpyousponsor.com/v1/admin/donors \
--header 'X-HYS-API-Key: hys_your_key_here'
API keys can be given a name and an optional expiration date. The full key is only shown once at creation time — store it securely. You can revoke a key at any time from Developer Settings.

​
Response Codes

Our API utilizes standard HTTP status codes to indicate the success or failure of a request:
  1. 200: Successful request.
  2. 401: Unauthorized access.
  3. 500: Internal server error.

​
Conclusion

The HelpYouSponsor API is a powerful tool designed to enhance your Non-profits functionality. By following this documentation, you will be able to integrate our API seamlessly and leverage its features to improve your platform’s efficiency and user experience. If you have any questions or need further assistance, please refer to our support page or contact our technical team.