Request for API access: Bella

[BellaZaytune]

• Please tell us about yourself (include an email address):

• Your purpose in using this API:

• API rate limits:

  • Maximum requests per second:
  • Maximum requests per day:

• Is your use case better served by having an offline dump of hadith data or programmatic API access?

• What are the languages in which would you like hadith data?

• What programming language will your API client be in?

[BellaZaytune]

I am one of the developers/administrators responsible for the technical implementation and content delivery of the IslamMyReligion website.

• Email Address: [email protected]

Your purpose in using this API:

The primary purpose is to create a publicly accessible, dynamic, and searchable "Hadith Viewer" page on islammyreligion.com. This page will allow site visitors to:

1. Browse authenticated Hadith collections (like Sahih al-Bukhari).
2. Select Hadith by specific Book and Chapter (e.g., Sahih al-Bukhari, Chapter 1).
3. Filter or search the loaded Hadith text (both English and Arabic) in real-time.
4. Display the full text (English and Arabic) of each Hadith, along with sourcing details.

This API will serve as the reliable back-end source for all Hadith content displayed on the site.

API rate limits:

We understand the importance of respecting API limits to ensure service stability for all users. We are currently adhering to the limits associated with a standard developer plan, which we anticipate are:

• Maximum requests per second: 1 (We use client-side debouncing and caching the chapter list to minimize unnecessary requests.)
• Maximum requests per day: 1,000 – 10,000 (We plan to monitor usage and upgrade our plan if traffic exceeds these limits.)

Is your use case better served by having an offline dump of hadith data or programmatic API access?

Our use case is better served by programmatic API access.

Reasoning:

1. Server Resources: An offline dump is massive (gigabytes) and would consume excessive disk space, require complex internal indexing (e.g., Elasticsearch), and drain server resources on a shared hosting environment.
2. Dynamic Loading: We only need to load the content of a single chapter (often 20-50 Hadith) at a time, which is efficiently handled by the API's /hadiths/chapter endpoint. This provides a fast, lightweight user experience.
3. Maintenance: Relying on the API ensures we always receive data that the API provider maintains and updates, reducing our maintenance overhead.

What are the languages in which would you like hadith data?

We require data in the following two languages:

1. Arabic (The original source text)
2. English (The primary language for our readership)

What programming language will your API client be in?

Our application uses a client-server architecture:

• Server-Side: PHP (Used as a proxy file to securely hide the API key and manage the API connection).
• Client-Side: JavaScript (Used in the browser for making the fetch requests to the PHP proxy and dynamically rendering the results on the webpage).