Documentation

Getting Started with the DHCS Developer Portal (Consumers)

Overview

This guide walks you through the essential steps to begin consuming DHCS APIs through the DHCS Developer Portal. Learn how to navigate the site, explore accessible APIs, and obtain credentials. Following this guide will help you quickly establish the foundational setup needed for API integration.

Prerequisites

  • Portal access
    Make sure you have registered, make sure that you can successfully log in to the DHCS Developer Portal with your credentials.

Getting help: If you need assistance with any of the API services provided by the DHCS Developer Portal, please open a request through the Support Center link in the footer.

Portal Features

API Catalog - Search our API products and discover how you can integrate with our endpoints.

Documentation - Learn more about how to interact with this portal and what API services and products we support.

Access Requests - View all access requests and pending API approvals in one place.

Sign Out - Log out from the portal.

Things to keep in mind while navigating the portal

Curated views - The portal will display only the APIs accessible to you.

Role-based features - Your access to features depends on your team and role (“Consumer,” “Producer,” or “Admin”).

API Catalog

Browsing APIs

You can view accessible APIs from multiple locations on the portal.

  • Home page: Select the API Catalog tile
  • Navigation bar: Select the API Catalog tab from the navigation panel

To learn more about searching our API Catalog, please see: Search and discover an API

Exploring APIs

The Developer Portal leverages an integrated version of Swagger UI to provide a set of interactive documentation for each API. Before consuming data from an API, you can test calls, view responses, and examine request/response schema directly in your browser with “Try it out” functionality. To locate an API to explore, see the Browsing APIs section above.

To learn more about exploring APIs and the “Try it out” feature, please see: How to Use Swagger UI and “Try it Out” in the DHCS Developer Portal

Requesting API Access

To access an API on the developer portal, start from the API Catalog and submit an access request. After submission, you will receive email updates about the approval status from the API owner. Once approved, retrieve your credentials from the Access Requests page.

To learn more about this process, please see Accessing an API in our How To Guide for Consumers.

Access Requests

Select the Access Requests tab in the navigation bar to view your API access requests.

For more information on API Access Requests, Approvals, and Credentials, please see: How To Guide for Using a DHCS API.

Documentation

In addition to this guide, the Developer Portal provides resources for both DHCS API Consumers and Producers, allowing your team to quickly get up to speed on accessing the data that you need.

Support

If you need assistance troubleshooting an API, require access, or having any other issues related to the API Developer Portal, please follow the instructions below to submit a support request with our online help desk.

Submitting a Request to the Help Center

Select the Support Center link in the footer navigation panel on any page of the portal.

Submit your Request

Fill in all required fields (*) on the Support Request modal and select the Submit button.