The RxLocal Mobile Applications allow for third party applications to \"deep-link\" into them from iOS and Android applications or websites.
\nThis documentation details the current supported API for deep-linking.
\nPioneerRx pharmacies can enroll in the RxLocal mobile product by contacting our Sales Department at apps@pioneerrx.com. The full RxLocal product including most of the deep linking capabilities requires an active enrollment by the pharmacy. If the pharmacy elects to stop this enrollment, the deep linking abilities will no longer work, and end users will receive error messages alerting them to that effect.
\nNote that RxLocal Mobile version 4.x or higher is required to be installed on the mobile device for deep links to work. If it is not installed, the user will be prompted to install it when using iOS Universal Links or Android Deep Links.
\nThe links to the latest RxLocal applications are:
\n\nThe RxLocal product previously offered custom, or \"templated\" versions of the application to pharmacies. These applications are no longer supported, and these customers are being transitioned to the new RxLocal branded application. They must transition to the new app to use the new Deep Linking features.
\nParameters will each have a datatype provided for them. The convention is to list them as follows: {type}
\nMost API calls offer the ability to pass in a \"returnURL\" and \"returnAppName\". These 2 parameters allow for the end user to be shown options to return to your application throughout parts of the workflow.
\nIn order for your application to open to ours and given context of a particular pharmacy, you must register yourself with PioneerRx's RxLocal Sales Department, here. A unique identifier (GUID) will be provided to you for each pharmacy.
\nWe refer to this GUID as \"DEI\" or \"Data Exchange Identifier\". It is a standard ID that the RxLocal and PioneerRx systems use to refer to locations when communicating with vendors.
\nWhen an API accepts a DEI, if one is not provided, the application will open to the primary patient for the activity supplied.
\n(Note that if you were provided IDs for legacy APIs, those IDs are no longer valid).
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Conventions","slug":"conventions"},{"content":"Registering Pharmacies","slug":"registering-pharmacies"}],"owner":"4703685","collectionId":"f6f88fee-3675-49cd-8d8e-8e415ec103c0","publishedId":"RWMLJkaU","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"035299","highlight":"EF5E2B"},"publishDate":"2018-07-27T15:08:41.000Z"},"item":[{"name":"Deep Links","item":[{"name":"Register","id":"c003b8d2-b882-493d-b1f2-2b156061c7e3","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://app.rxlocal.com/register?dei={guid?}","description":"Will allow the end user to begin the registration process. If you pass in the DEI, it will pre-select the pharmacy associated with that ID.
\nIf the user is already enrolled, it will simply open the app to that user's homepage.
\n","urlObject":{"protocol":"https","path":["register"],"host":["app","rxlocal","com"],"query":[{"description":{"content":"A unique identifier provided to you by RxLocal when you Register a pharmacy with your production though our Sales Department.
\n","type":"text/plain"},"key":"dei","value":"{guid?}"}],"variable":[]}},"response":[],"_postman_id":"c003b8d2-b882-493d-b1f2-2b156061c7e3"},{"name":"Refill","id":"a3858eb4-5e7a-46bc-8c6c-4dc7308c919e","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://app.rxlocal.com/refill?dei={guid?}&returnAppName={string?}&returnAppURL={url?}&firstName={string?}&lastName={string?}&personID={guid?}","description":"Will open the user up to the Refill Workflow. If the user is not logged in, it will take them to the login screen. If they select the Register option here, it will pre-select the pharmacy provided as the DEI automatically for them.
\nIf the optional first and last name of the patient is provided the app will attempt to locate that patient in the logged in profile and open that patient for refills. If not found, or not provided, a menu will be shown to the user to select the patient if multiple patients are part of the profile; if only one patient is part of the profile, he/she will be selected.
\n","urlObject":{"protocol":"https","path":["refill"],"host":["app","rxlocal","com"],"query":[{"description":{"content":"A unique identifier provided to you by RxLocal when you Register a pharmacy with your production though our Sales Department.
\n","type":"text/plain"},"key":"dei","value":"{guid?}"},{"description":{"content":"This name will be displayed to the user with actions they can select to return to your application. If provided, it will only be shown if returnAppURL is also set. Limit to approximately 30 characters to avoid ellipsis.
\n","type":"text/plain"},"key":"returnAppName","value":"{string?}"},{"description":{"content":"This URL will be used to redirect a user back to your application.
\n","type":"text/plain"},"key":"returnAppURL","value":"{url?}"},{"description":{"content":"The first name of the patient to refill for. If provided, this will select the first patient with this name that is on this RxLocal Profile. Requires Last Name to function.
\n","type":"text/plain"},"key":"firstName","value":"{string?}"},{"description":{"content":"The last name of the patient to refill for. If provided, this will select the first patient with this name that is on this RxLocal Profile. Requires First Name to function.
\n","type":"text/plain"},"key":"lastName","value":"{string?}"},{"description":{"content":"An alternative id for the patient to select them. Only vendors that get this from other feeds (data feeds) have access to this information.
\n","type":"text/plain"},"key":"personID","value":"{guid?}"}],"variable":[]}},"response":[],"_postman_id":"a3858eb4-5e7a-46bc-8c6c-4dc7308c919e"},{"name":"Profile","id":"906456b4-331f-4f25-ab08-bfe5e3de8633","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://app.rxlocal.com/profile?dei={guid?}&firstName={string?}&lastName={string?}&personID={guid?}","description":"Will open the user up to the Profile Workflow. If the user is not logged in, it will take them to the login screen. If they select the Register option here, it will pre-select the pharmacy provided as the DEI automatically for them.
\nIf the optional first and last name of the patient is provided the app will attempt to locate that patient in the logged in profile and open that patient for profiles. If not found, or not provided, a menu will be shown to the user to select the patient.
\n","urlObject":{"protocol":"https","path":["profile"],"host":["app","rxlocal","com"],"query":[{"description":{"content":"A unique identifier provided to you by RxLocal when you Register a pharmacy with your production though our Sales Department.
\n","type":"text/plain"},"key":"dei","value":"{guid?}"},{"description":{"content":"The first name of the patient to refill for. If provided, this will select the first patient with this name that is on this RxLocal Profile. Requires Last Name to function.
\n","type":"text/plain"},"key":"firstName","value":"{string?}"},{"description":{"content":"The last name of the patient to refill for. If provided, this will select the first patient with this name that is on this RxLocal Profile. Requires First Name to function.
\n","type":"text/plain"},"key":"lastName","value":"{string?}"},{"description":{"content":"An alternative id for the patient to select them. Only vendors that get this from other feeds (data feeds) have access to this information.
\n","type":"text/plain"},"key":"personID","value":"{guid?}"}],"variable":[]}},"response":[],"_postman_id":"906456b4-331f-4f25-ab08-bfe5e3de8633"},{"name":"Reminders","id":"f30d9855-b290-4e07-a52f-94f86f5c5dc1","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://app.rxlocal.com/reminders?dei={guid?}","description":"Will open the user up to the Reminders Workflow. If the user is not logged in, it will take them to the login screen. If they select the Register option here, it will pre-select the pharmacy provided as the DEI automatically for them.
\n","urlObject":{"protocol":"https","path":["reminders"],"host":["app","rxlocal","com"],"query":[{"description":{"content":"A unique identifier provided to you by RxLocal when you Register a pharmacy with your production though our Sales Department.
\n","type":"text/plain"},"key":"dei","value":"{guid?}"}],"variable":[]}},"response":[],"_postman_id":"f30d9855-b290-4e07-a52f-94f86f5c5dc1"},{"name":"Messaging","id":"b27901b4-5176-4479-af38-45dd0b4667a5","request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://app.rxlocal.com/messaging?dei={guid?}&firstName={string?}&lastName={string?}&personID={guid?}","description":"Will open the user up to the Messaging Workflow. If the user is not logged in, it will take them to the login screen. If they select the Register option here, it will pre-select the pharmacy provided as the DEI automatically for them.
\nIf the optional first and last name of the patient is provided the app will attempt to locate that patient in the logged in profile and open that patient for messaging. If not found, or not provided, a menu will be shown to the user to select the patient if multiple patients are part of the profile; if only one patient is part of the profile, he/she will be selected.
\n","urlObject":{"protocol":"https","path":["messaging"],"host":["app","rxlocal","com"],"query":[{"description":{"content":"A unique identifier provided to you by RxLocal when you Register a pharmacy with your production though our Sales Department.
\n","type":"text/plain"},"key":"dei","value":"{guid?}"},{"description":{"content":"The first name of the patient to refill for. If provided, this will select the first patient with this name that is on this RxLocal Profile. Requires Last Name to function.
\n","type":"text/plain"},"key":"firstName","value":"{string?}"},{"description":{"content":"The last name of the patient to refill for. If provided, this will select the first patient with this name that is on this RxLocal Profile. Requires First Name to function.
\n","type":"text/plain"},"key":"lastName","value":"{string?}"},{"description":{"content":"An alternative id for the patient to select them. Only vendors that get this from other feeds (data feeds) have access to this information.
\n","type":"text/plain"},"key":"personID","value":"{guid?}"}],"variable":[]}},"response":[],"_postman_id":"b27901b4-5176-4479-af38-45dd0b4667a5"}],"id":"f3da7835-9c8f-42a3-8d88-2959b4016e45","description":"iOS Universal Links is a form of deep linking offered by iOS 9 or higher.
\nMore information about this technology is provided by Apple here.
\nAndroid refers to this simly as \"App Links\" and is offered on Android 6.0 (API level 23) or higher.
\nMore information about this technology is provided by Google here.
\nUsing Deep Links will automatically prompt users to install applications on supported Operating Systems by directing them to the App Store where they can install the RxLocal Application. This allows your application to not have to worry with this redirection in your code and solely focus on the API that is provided.
\n","event":[{"listen":"prerequest","script":{"id":"64f03b30-0922-4936-b602-3240d19e5cd9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"713dfd26-6b31-436e-a1c6-f6bcb0408c70","type":"text/javascript","exec":[""]}}],"_postman_id":"f3da7835-9c8f-42a3-8d88-2959b4016e45"}],"event":[{"listen":"prerequest","script":{"id":"143b9e1d-1e40-4b47-8999-24e767aec6e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d715e49-3eb9-435a-b03f-d30a9097a1f2","type":"text/javascript","exec":[""]}}]}