OC Cadou Manager   •   almost 5 years ago

Near Me Feature - Specialty Code

The parameter "entry" is an advanced parameter to change the entry screen when the SDK initializes.
The parameter "entry.screenName" stands for a technical key to set on which screen you want the user to land: For now it only supports 2 values: "home" and "searchNearMe".
In case the value is set to "searchNearMe", a second parameter "entry.specialtyCode" will be mandatory and should be a valid specialty code.

To retrieve specialtyCode: a direct access to the API is possible using the endpoint https://api.healthcarelocator.com/api/graphql

This URL is reachable with a valid subscription key :
https://api.healthcarelocator.com/api/graphql?subscription-key=XXXXXXXX

Once connected, the user can access the following screen. This is screen is split in 3 + parts, on the left upper, the query editor, on the bottom left, the header definition, on the right part the results of the query.
On the very right of the screen, two tabs are reachable to get access to the data schema and API documentation.
The documentation can be used to format queries that can let end user access SDK data.

• 4 comments
• 

  Nongnooch Roongpiboonsopit   •   almost 5 years ago

  Hi, the busy spinner keeps showing in the data schema and API documentation tabs and I was unable to access those documentations.

  Is this a known issue?

• 

  emmanuel valentin Manager   •   almost 5 years ago

  Hi,

  Be sure to use the url with the subscription key you've received by mail.
  https://api.healthcarelocator.com/api/graphql?subscription-key={?????}

  Once you are in, add the subscription key in HTTP Headers as following:
  {
  "Ocp-Apim-Subscription-Key":"?????"
  }

  once this is done, you should be able to execute a query following schema & docs available in the playground.

  Emmanuel

• 

  Nongnooch Roongpiboonsopit   •   almost 5 years ago

  Hi Emmanuel,
  Thank you so much for your help! I'll definitely try it out when integrating the SDK with my app :)

  I was trying to play with the GraphQL in my browser using the following url
  https://api.healthcarelocator.com/api/graphql?subscription-key={my_key}

  and the query was not running and the api documentations were not showing up and it turns out that

  Turns out that I also needs to update the curl in the GraphQL ui to include my subscription-key
  https://api.healthcarelocator.com/api/graphql/query?subscription-key={my_key}

  and I can use the GraphQL ui now :)

  FWIW, below is a GraphQL query that I used to try out the UI inspiring by the hclAPI.codesByLabel example: below
  https://docs.healthcarelocator.com/index.htm#t=JavaScript%2FOverview_for_SDK_integration_within_JavaScript_apps.htm

  // ---------
  {
  codesByLabel(first: 10, offset: 0, criteria: "", locale: "en", codeTypes: ["TIT"]) {
  codes {id, lisCode}
  }
  }

  // ------------

  Cheers!
  Nong

• 

  Nongnooch Roongpiboonsopit   •   almost 5 years ago

  Hi, about your original post:
  "In case the value is set to "searchNearMe", a second parameter "entry.specialtyCode" will be mandatory and should be a valid specialty code."

  How could I get a list of valid specialtyCode? I went through the documentation and schema in
  https://api.healthcarelocator.com/api/graphql

  but could not find a way to retrieve this information.

  Any help would be appreciated. Thanks!

Comments are closed.