Our Human Service Data API (HSDA) service is build in RUST and run on our own servers. Documentation for these APIs is provided via Swagger: Swagger Docs

Using Swagger, you can make API calls, try different parameters, see examples of implementation in multiple programming languages, etc.

As part of onboarding, you will have received a secure link that shares:

Your unique Swagger link
A username
A password
An API key

Your username and password are only for accessing Swagger documentation. Your code will only need the API key and an endpoint in order to function. The endpoints you can use are documented in swagger, however.

</aside>

How To Use Swagger

In order to access and use Swagger, you need to authenticate yourself in two steps:

Go to Swagger using the link we sent you and click on “Authorize” in the upper right corner.
Do not fill in the client_secret.
Do click “Authorize”.
You will be redirected to a login screen. Authenticate using the username and password provided.
You will be redirected back to Swagger.
Click “Close” and test the endpoints 🙂 You are done!

Using HSDA for Data Replication

The primary endpoint we support at this time (from among many in the HSDA specification) is organizations. This endpoint, when used in conjunction with the ?full=true parameter, returns an entire data set (paginated). The returned JSON is large but efficient: it contains organizations with every service and location related to that organization nested inside. All additional data that we have in our system including phone numbers, schedule, eligibility criteria, custom taxonomies, etc is nested inside the appropriate core table object tables.

Use /organization?full=true when you want to fetch a complete data set for replication.

</aside>

As an extension of HSDS, the nested service_at_location object also contains additional information that’s helpful in a publishing context, such as how to format a resource name, which phone number to call first, and more.