AP Temples Partner API Docs Help

Partner API Overview

Introduction

Welcome to the Andhra Pradesh State Temple Management System API. This API is designed to provide our partners, primarily those in the travel and tourism sectors, with a seamless way to integrate and utilize our services.

Our API allows partners to book sevas and other services provided by the temples of Andhra Pradesh directly from their websites and mobile applications. This not only enhances the user experience but also broadens the reach of our services.

The API is built with a focus on simplicity and ease of integration. It follows RESTful principles, making it easy for developers to understand and work with. It provides a range of endpoints for booking and managing sevas, retrieving temple information, and more.

Whether you're a travel agency looking to provide your customers with a unique spiritual experience, or a tourism platform aiming to broaden your offerings, our API can help you achieve your goals.

For more information on how to get started, please refer to the 'Getting Started' section. For detailed information about each endpoint, see the 'API Reference' section. If you need further assistance, please refer to the 'Support' section.

What you can do using AP Temples TMS API

  1. Get Temple Information: Retrieve information about the temples of Andhra Pradesh, including their location, contact details, and more.

  2. Get Seva/Darshanam Information: Retrieve information about the sevas and darshanams offered by the temples of Andhra Pradesh, including their price, duration, and more.

  3. Get Seva/Darshanam Availability: Check the availability of sevas and darshanams offered by the temples of Andhra Pradesh.

  4. Book Sevas/Darshanams: Book sevas and darshanams offered by the temples of Andhra Pradesh.

  5. Get Seva/Darshanam Booking Information: Retrieve information about seva and darshanam bookings made by your customers.

  6. Get Seva/Darshanam Booking Status: Check the status of seva and darshanam bookings made by your customers.

  7. Print Seva/Darshanam Tickets: Print seva and darshanam tickets for your customers.

Authentication

The Andhra Pradesh State Temple Management System API uses API keys to authenticate requests. You can generate your API key by reaching out to us at aped-tms@9and9.com. Your API key should be kept confidential and not disclosed in public.

You will be provided with Partner Code, Primary API Key and Backup API Key. The Primary API Key is used for all API requests. The Backup API Key is used only when the Primary API Key is undergoing rotation. Ensure that the Backup API Key is not rotated simultaneously while rotating the Primary API Key.

Authentication is done by using the X-Partner-Code and X-Api-Key as headers in the API requests.

When you are provided with the credentials the support will also provide access to the applicable temple(s) and seva(s) for the partner. The partner can access the temple(s) only for which the access is provided.

You could check the temple access provided by using the API GET /api/v1/partner/api-key-info. The API will return the list of temple(s) for which the partner has access.

Base URL

Our API provides different base URLs for development and production environments. Please ensure to use the correct base URL depending on the environment you are working with.

Development URLs

  • Base URL: https://ds-api.aptemples.org

  • Reporting URL: https://ds-api.aptemples.org

  • PDF Service URL: https://ds-pdf-api.aptemples.org

Production URLs

  • Base URL: https://api.aptemples.org

  • Reporting URL: https://reporting-api.aptemples.org

  • PDF Service URL: https://pdf-api.aptemples.org

Please note that the base URL is used for all general API requests. The Reporting URL is used for all reporting-related API requests. The PDF Service URL is used for all PDF-related API requests like generating tickets.

Rate Limiting

Our API implements rate limiting to ensure fair usage and protect the service from abuse. The rate limiting is governed by the following settings:

THROTTLER_WINDOW_PERIOD: This is the time window for which the rate limit applies, measured in seconds. Currently, this is set to 10 seconds. This means that the number of requests a client can make is evaluated over a rolling window of 10 seconds.

THROTTLER_NUMBER_OF_REQUESTS: This is the maximum number of requests a client can make within the THROTTLER_WINDOW_PERIOD. Currently, this is set to 500 requests. This means that a client can make up to 500 requests every 10 seconds.

If a client exceeds the THROTTLER_NUMBER_OF_REQUESTS within the THROTTLER_WINDOW_PERIOD, subsequent requests from the client will be rejected until the start of the next window period. Please note that these settings are subject to change based on system performance and usage patterns. We recommend that clients implement appropriate error handling to deal with rate limit exceeded responses.

Versioning

Our API follows semantic versioning. This means that the API version is incremented whenever there are breaking changes. For example, if a new endpoint is added or an existing endpoint is removed, the API version will be incremented. If a new field is added to an existing endpoint, the API version will not be incremented.

Keep tab on the changes by visiting the Changes page.

Last modified: 04 December 2024
Getting Started