# API Guide

Welcome to the AMRIT API Guide. This page provides an overview of the various API services available in the AMRIT platform, along with links to their respective Swagger UIs for detailed documentation and testing.

* [Admin API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=admin-api)
* [Beneficiaryid Generation API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=beneficiaryid-generation-api)
* [Common API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=common-api)
* [Ecd API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=ecd-api)
* [FHIR API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=fhir-api)
* [Helpline 104 API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=helpline104-api)
* [Helpline 1097 API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=helpline1097-api)
* [Health and Wellness Centre API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=hwc-api)
* [Identity API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=identity-api)
* [Inventory API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=inventory-api)
* [Mobile Medical Unit API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=mmu-api)
* [Scheduler API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=scheduler-api)
* [TM API](https://psmri.github.io/AMRIT-Docs/swagger/?spec=tm-api)

**How to Use the APIs**

To start using AMRIT's APIs, follow these steps:

1. **Explore the Swagger UI:** Click on the links provided above to access the Swagger UI for each service. Swagger provides an interactive interface where you can view API endpoints, understand request/response structures, and even execute API calls directly from your browser.
2. **Authentication:** Many API services require authentication. Ensure you have the necessary API keys or tokens, which can be obtained by registering through the Authentication Service.
3. **Review the Documentation:** Each Swagger UI includes detailed documentation for every API endpoint. This includes the HTTP method (GET, POST, etc.) and required parameters.
4. **Test API Calls:** Use the "Try it out" feature in Swagger to test API calls directly. This helps you understand how to structure requests and interpret responses.

**Support**

If you encounter any issues while using the APIs or need further assistance, please reach out to us:

* **GitHub Discussions:** Ask questions and engage with the community [here](https://github.com/orgs/PSMRI/discussions).
* **Email Support:** Contact us directly at <amrit@piramalswasthya.org> for any specific queries or issues.

Thank you for using the AMRIT API. We’re committed to providing a robust and flexible platform to support your healthcare technology needs.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://piramal-swasthya.gitbook.io/amrit/architecture/api-guide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.