Welcome
API documentation is a guide that explains how to use an API, including its endpoints, parameters, requests, responses, and examples so developers can integrate with it correctly.
APIs documentation

Two groups of documentation, as follows:

Endpoints
  • Quran Ayahs (Under Construction) /api/v1/ayahs
  • Quran Surahs (Under Construction) /api/v1/surahs
  • Example Contacts /api/v1/contacts
Response Format

An APIs response format defines how data is structured of normal, error response.

  • Standard Response Format

    Response data is structured in JSON format with a data key containing the actual data, and meta key containing pagination information.

  • Error Response Format

    In case of an error, the response will contain a message key with a descriptive error message.