Getting Started

Getting Started with Azodha API

Requesting Access

To begin integrating with the Azodha API, you'll need to request access to our sandbox environment:

  1. You can request access by filling this form

  2. Complete the onboarding request form with your organization's details and intended use case.

  3. Submit the form for review by our integration team.

Onboarding Process

Once your request is approved:

  1. You'll receive an email to schedule a setup time with our integration team.

  2. During the setup meeting, you'll:

    1. Receive the NDA and necessary paperwork

    2. Get an overview of the integration process and the next steps

  3. After the setup meeting, you'll receive your :

    1. Organization Code,

    2. Access Code, and

    3. API Key

  4. Additionally, the team will also share access to your

    1. Sandbox environment

    2. Starter provider application

    3. Starter patient-facing application

Our integration team will be available to assist you throughout the onboarding process and answer any questions you may have.

Initial Setup

1. Authentication Setup

Use your Organization Code to fetch authentication credentials:

Get organization settings

get
Responses
200

Successful response

application/json
get
/organization-settings/
200

Successful response

No content

This endpoint returns the necessary credentials for your organization's authentication flows.

2. Enabling Authentication Flows

With your credentials, you can now set up various authentication and authorization flows:

  • OAuth 2.0

  • OpenID Connect

  • SAML 2.0

Refer to our Authentication & Authorization Guide for detailed implementation instructions.

3. Accessing Starter Applications

Log into the provided starter applications using your Access Code:

  • Provider Application: https://provider-sandbox.azodha.com

  • Patient Application: https://patient-sandbox.azodha.com

The URLs and access details for the provider and patient sandbox applications will be provided along with the API key.

These applications serve as reference implementations and can be customized to fit your needs.

4. Environment Configuration

Choose your preferred integration method:

  • Webhook: Automated patient data reception (recommended)

  • API: On-demand data requests

Next Steps

  1. Explore our API Reference Documentation to understand available endpoints and data models.

  2. Review our Integration Patterns Guide for best practices on data flow and system architecture.

For webhook configuration, consult our Webhooks documentation.

Last updated