API - Application Programming Interface

The Healthcare Administration Alliance features both public endpoints that do not require a member API Key and members-only endpoints.  The public endpoints are described below.




Public Endpoints

The public endpoints may be used by anyone to gather or display information about the members and the products/services offered by members of the Healthcare Administration Alliance.  Data is returned in JSON format.

get-certs-earned

URL:  https://www.healthadmin.org/api/get-certs-earned.php?email=sample@healthadmin.org  ← click to test

Returns a list of certifications earned by the person with the specified email address.

get-members

URL:  https://www.healthadmin.org/api/get-members.php  ← click to test

Returns a list of members of the Healthcare Administration Alliance.  Member ID numbers can be used to filter the resources results (see below get-resources API).

get-tags

URL:  https://www.healthadmin.org/api/get-tags.php  ← click to test

Returns a list of resource tags.  Resource tag ID numbers can be used to filter the resources results (see below get-resources API).

The list of tags includes a value showing which resources the tag applies to (ie. Certification, CEU, etc.).  If a tag id is submitted and the tag can only be used for a particular resource type, NO OTHER resource types will be returned.  For example, if tag id 36 (CEU Fee: Free) is submitted, only CEUs will be returned - it acts as a type filter.

get-resources

URL:  https://www.healthadmin.org/api/get-resources.php  ← click to test

Returns a list of resources (Trainings, Certifications, CEUs, Tools).  The results can be filtered based on type of resource, members (see get-member API above), and tags (see get-tags API above).

Pass in parameters as a JSON object to filter the resource results:

{
  "types": optional, array[], (one or more of: "All" | "Trainings" | "Certifications" | "CEUs" | "Tools") - blank = "All"
  "tag_ids": optional, array[] (AND - matching resource must have ALL tags specified)
  "member_ids": optional, array[] (OR - matching resource can be from ANY member specified)
}

Results format (also JSON)

{ 
  "status": "success"
  "errors": array[] - list of errors
  "request": string (JSON parameters requested)
  "received_gmt": datetime - Greenwich Mean Time
  "data": array
  [
    "type": string (one of: "Training" | "Certification" | "CEU" | "Tool")
    "key": string (member_id+"|"+resource_id)
    "id": string (member's resource/product id)
    "resource_name": string
    "member_name": string
    "link_url": string
    "image_url": string
    "extra": array (format depends on type of resource)
      Training:      { "delivery_type": (one of: "In Person" | "Online") }
      Certification: { "test_type": (one of: "Proctored" | "Online")
                       "initials": string }
      CEU:           { "credits": decimal
                       "presentation_type": (one of: "Live Only", "On Demand Only", "Live and On Demand")
                       "presented_on": date
                       "presentation_fee": (one of: "Yes" | "No")
                       "on_demand_url": string
                       "on_demand_fee": (one of: "Yes" | "No") }
      Tools:         { "tool_type": (one of: "Book" | "Card" | "File", "Website")
                       "fee": (one of: "Yes" | "No") }
  ]
}

example: filter for types

JSON:    click to test

{ "types": ["Certifications", "Tools"] }

example: filter for tag ids

JSON:    click to test    (1 - Coding, 9 - Cardiology)

{ "tag_ids": ["1", "9"] }

example: filter for member id

JSON:    click to test

{ "member_ids": ["2541"] }

example: filter for type and member id

JSON:    click to test

{ "types": ["Tools"], "member_ids": ["2541"] }

display on website - javascript code:




produces: