Frequently Asked Questions 🙋🏽‍♂️

Why is Authentication not working?

If you’re finding that you are sending Authentication headers but the request is not being accepted, you may be using the wrong server environment, or your web server may be stripping the headers. Double-check your headers and your API URL prior to creating a support ticket.

Additionally, check to make sure that you are connected to the VPN.

What are the requirements for a Support Program ID?

For each program, partners must provide both sandbox and production Support Program IDs (supportProgramId), which should be 36-digit alphanumeric numbers.

The supportProgramId field must be included in all API calls.

Does RxWare supply the Support Program ID?

No, a unique 36-digit alphanumeric Support Program ID for both the testing and production environments should be supplied by the partner.

Where can I find API code examples?

You can view our current code examples by starting with the sections below on this site. This documentation includes guides, best practices, use cases, and technical specifications.

How can I test against the API without affecting live data?

Our API Sandbox demo environment can be used to test any API request against test data.

This site is refreshed nightly to clear any activity.

Partners can send Postman requests before connecting to their production environments to test.

The login credentials detailed below are supplied after receipt of API documentation from partners:

     

      • Token

      • Username

      • Password

    How will test users’ phone numbers be registered with the RxWare system?

    All users must register their mobile devices via our RxWareTest User and Device Registration page at least 24 hours before a scheduled UAT session.

       

        • Input your Name, Company Name, and Phone Number, and click the Register Device button.

        • Initial tests are guided by RxWare, and subsequent tests are independent.

        • If a test user’s phone number will be used for multiple use cases, the partner must notify RxWare after each use case is completed to clear the test number.

        • Users must clear the cache and cookies on the testing device after each use case.

        • If possible, please test each use case on a different phone number.

        • All sandbox and production test phone numbers must be provided to RxWare at least 24 hours before testing.

      Below is a screenshot of the RxWare Test User and Device Registration page for allow listing phone numbers:

      RxWare Test User and Device Registration screenshot

      Does RxWare send events HelpAround.Patient.InvitationDelivery only for Invite calls or Case Updates as well?

      This callback is only sent for the Invite API call.

      What does “skip onboarding” mean within the Invite API call?

      The skip onboarding flag allows the partner to provide all of a patient’s enrollment details if HIPAA, TCPA, or Texting consent has already been collected manually and enroll the patient into the brand’s patient journey.

      Can the Enrollment Get Media API support multiple PDFs?

      Our enrollment API request contains many media ids that represent multiple and different PDFs (insurance card front and back for example). We do not support multiple PDFs in the same request or unite multiple files into one due to size limitations

      The Enrollment Webhook must be implemented so that you can retrieve media files.

      Media data: expected media files (e.g. insurance card, signature) can be fetched via IDs that are provided in this Enrollment API Post.

      Also, reference the Get patient’s media request.

      Do the RxWare APIs detailed in this site support the option to add custom rules from our internal style guides or existing APIs?

      This functionality is not supported in the initial release of the feature. If you do have rules you’d like to see added to API Standardization, please reach out to us at implementation@rxware.io. We want your feedback so we can continue to evolve the tool to meet the needs of API teams.

      How do I re-invite a patient if the call failed due to incorrect programming on my end?

      Please utilize our Re-Invite call.

      This API call will trigger the invite SMS to the patient again.

      What is the difference between the Case Update and Invite API’s?

      Our partners use the Invite API to invite a patient to a new Support Program.

      Our partners use the Case Update API call to provide an update on the patient’s status after the initial invite has been sent to the patient and their record exists in the RxWare databases.

      Case Updates will:

         

          1. Update the patient’s status in our database

          1. Create a patient interaction, notification, or call to action (optional)

        How do I access Case Update and Direct-to-SMS API calls within the documentation?

        They are detailed in the Case Updates (PARTNER RxWare) section of this site.

        After your organization has completed the contracting process with RxWare, you will then receive the appropriate sandbox and production API URLs.

        NEXT: ➡️ Glossary of Terms

        Frequently Asked Questions
        Skip to content