|
| 1 | +--- |
| 2 | +layout: mini-hub |
| 3 | +title: Check you are ready for integration |
| 4 | +nav_order: 5 |
| 5 | +permalink: /get-started-new/check-you-are-ready-for-integration |
| 6 | +mini_hub_topic: You must follow the steps to prepare for integration |
| 7 | +mini_hub_pages: |
| 8 | + - title: Check you can use NHS Notify |
| 9 | + url: /get-started-new/check-you-can-use-nhs-notify |
| 10 | + - title: Read and understand our terms of service |
| 11 | + url: /get-started-new/read-and-understand-our-terms-of-service |
| 12 | + - title: Understand our onboarding timescales |
| 13 | + url: /get-started-new/understand-onboarding-timescales |
| 14 | + - title: Check you are ready for integration |
| 15 | + url: |
| 16 | + current: true |
| 17 | + - title: Check which features you need and register |
| 18 | + url: /get-started-new/check-which-features-you-need-and-register |
| 19 | +previous_page: |
| 20 | + title: Understand our onboarding timescales |
| 21 | + url: /get-started-new/understand-onboarding-timescales |
| 22 | +next_page: |
| 23 | + title: Check which features you need and register |
| 24 | + url: /get-started-new/check-which-features-you-need-and-register |
| 25 | +published: false |
| 26 | +--- |
| 27 | + |
| 28 | +## 1. Prepare your integration |
| 29 | + |
| 30 | +You must prepare your integration before you can get access to NHS Notify's integration environment. |
| 31 | + |
| 32 | +You'll need technical or developer support to complete tasks in this step. |
| 33 | + |
| 34 | +### If you're using NHS Notify API |
| 35 | + |
| 36 | +You'll need to: |
| 37 | + |
| 38 | +{% include components/details.html |
| 39 | +heading='Set up your APIM application ID' |
| 40 | +text="To set up an APIM application ID, you need to: |
| 41 | + |
| 42 | +1. <a href='https://digital.nhs.uk/developer' target='_blank'>Sign in to your NHS Digital developer account (opens in a new tab)</a>. |
| 43 | +2. Create an APIM application. |
| 44 | +3. Select 'integration test' as the environment. |
| 45 | +4. Select 'Communications Manager (integration environment)' as the connected API. |
| 46 | + " |
| 47 | + %} |
| 48 | + |
| 49 | +{% include components/details.html |
| 50 | +heading='Choose how you want to see your message performance' |
| 51 | +text="To see how your messages perform, you can <a href='https://digital.nhs.uk/developer/api-catalogue/nhs-notify#get-/v1/messages/-messageId-' target='_blank'>get the status of a message (opens in a new tab)</a> or choose to receive <a href='https://digital.nhs.uk/developer/api-catalogue/nhs-notify#post-/%3Cclient-provided-message-status-URI%3E' target='_blank'>realtime message callbacks (opens in a new tab)</a>. |
| 52 | + |
| 53 | +If you want to receive realtime message status callbacks, you'll need to: |
| 54 | + |
| 55 | +- decide which [message, channel or supplier statuses](/using-nhs-notify/message-channel-supplier-status) you want to receive |
| 56 | +- prepare an endpoint URL for your integration |
| 57 | + " |
| 58 | + %} |
| 59 | + |
| 60 | +### If you're using NHS Notify MESH |
| 61 | + |
| 62 | +You'll need to: |
| 63 | + |
| 64 | +1. <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh/set-up-nhs-notify-mesh#set-up-your-mesh-mailboxes" target="_blank">Set up your MESH mailboxes (opens in a new tab)</a> and make a note of their IDs. |
| 65 | +2. Decide which reports you want when you get reports on how your messages perform. |
| 66 | + |
| 67 | +## 2. Confirm your setup to get access to our integration environment |
| 68 | + |
| 69 | +You must confirm how you'll be set up with NHS Notify using our online form so we can prepare your integration environment to meet your needs. |
| 70 | + |
| 71 | +{% include components/inset-text.html |
| 72 | + text='Only complete the online form and confirm your setup if you’ve been invited to onboard.' |
| 73 | + classes='nhsuk-u-margin-top-2' |
| 74 | +%} |
| 75 | + |
| 76 | +{% include components/action-link.html |
| 77 | + url='https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNFRYSDFTOUs5TzZQUjlOVUlGWTQxQTlMQy4u' |
| 78 | + text='Confirm your setup with NHS Notify' |
| 79 | +%} |
| 80 | + |
| 81 | +### Before you confirm your setup |
| 82 | + |
| 83 | +In the form you'll be asked to: |
| 84 | + |
| 85 | +{% include components/details.html |
| 86 | +heading='Confirm your use case' |
| 87 | +text='You can only use NHS Notify if your organisation or service sends messages that are: |
| 88 | + |
| 89 | +- [part of a campaign](/using-nhs-notify/campaigns) |
| 90 | +- [triggered when something happens in your service](/using-nhs-notify/event-based-messaging) |
| 91 | +- [sent directly on a one-to-one basis](/using-nhs-notify/direct-messaging) |
| 92 | + ' |
| 93 | + %} |
| 94 | + |
| 95 | +{% include components/details.html |
| 96 | +heading='Provide your message sender names' |
| 97 | +text='When you send messages you’ll need to tell your recipients who your messages are from by creating message sender names. |
| 98 | + |
| 99 | +Before you provide your message sender names, you should understand more about: |
| 100 | + |
| 101 | +- [NHS App sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#nhs-app-sender-name) |
| 102 | +- [email sender names and from addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#email-sender-name-and-from-email-address) |
| 103 | +- [email reply-to email addresses](/using-nhs-notify/tell-recipients-who-your-messages-are-from#reply-to-email-address) |
| 104 | +- [text message sender names](/using-nhs-notify/tell-recipients-who-your-messages-are-from#text-message-sender-name) |
| 105 | + ' |
| 106 | + %} |
| 107 | + |
| 108 | +{% include components/details.html |
| 109 | +heading='Provide more detail about your messages and how they’ll be sent' |
| 110 | +text='You’ll be asked if your organisation or service will: |
| 111 | + |
| 112 | +- have finished drafts of the messages you want to send |
| 113 | +- send NHS App messages and if so, which links and URLs you’ll include |
| 114 | +- send letters in other languages and if so, which languages |
| 115 | +- send letters in accessible formats and if so, which formats |
| 116 | +- use Personal Demographics Service (PDS) fields |
| 117 | +- have your PDS test data ready |
| 118 | +- use custom personalisation fields |
| 119 | +- have test data prepared for your custom personalisation fields |
| 120 | + |
| 121 | +The form will also ask for the routing plans that you want to use for your messages. |
| 122 | +' |
| 123 | +%} |
| 124 | + |
| 125 | +{% include components/details.html |
| 126 | +heading='Tell us who will create and submit templates' |
| 127 | +text='You do not need to do this if you send direct messages and use free-text inputs. |
| 128 | + |
| 129 | +When you get access to NHS Notify’s integration environment, you’ll need to [create and submit your templates](/using-nhs-notify/create-and-submit-a-template). These templates will be used as the messages you send when you go live. |
| 130 | + |
| 131 | +To access this feature, you must nominate someone in your organisation or service to sign in with NHS Notify. This is because creating and submitting templates is only available to one person in an organisation or service at this time. |
| 132 | + |
| 133 | +To sign into NHS Notify you must have a Care Identity (CIS2 authentication). If you do not have a Care Identity, we can help you create one. |
| 134 | +' |
| 135 | +%} |
| 136 | + |
| 137 | +{% include components/details.html |
| 138 | +heading='Give accurate estimates on your message volumes and frequency' |
| 139 | +text='We need to understand how many messages you need to send and how often to set up your integration environment. |
| 140 | + |
| 141 | +You’ll need to provide: |
| 142 | + |
| 143 | +- how many messages you want to send per day |
| 144 | +- the maximum amount of messages you might send per day |
| 145 | + ' |
| 146 | + %} |
| 147 | + |
| 148 | +After you submit the form, it will be reviewed by NHS Notify's onboarding team. |
| 149 | + |
| 150 | +They'll contact you to either: |
| 151 | + |
| 152 | +- ask you about some of the answers you provided |
| 153 | +- provide access to NHS Notify's integration environment |
| 154 | + |
| 155 | +## 3. Build your integration |
| 156 | + |
| 157 | +Once you get access to our integration environment, you can start building your integration with <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify" target="_blank">NHS Notify API (opens in a new tab)</a> or <a href="https://digital.nhs.uk/developer/api-catalogue/nhs-notify-mesh" target="_blank">NHS Notify MESH (opens in a new tab)</a>. |
| 158 | + |
| 159 | +How you build your integration to meet your needs is your responsibility. |
| 160 | + |
| 161 | +If you're sending campaign or event based messages, you need to create and submit your templates during this step. You will also need to [approve your messages before we send them]({% link pages/using-nhs-notify/approve-your-messages.md %}). |
| 162 | + |
| 163 | +## 4. Complete integration testing |
| 164 | + |
| 165 | +You'll need to [complete integration testing]({% link pages/using-nhs-notify/complete-your-testing.md %}) to make sure you're ready to start sending messages with NHS Notify. |
| 166 | + |
| 167 | +If you're sending NHS App messages, you'll also need to [complete NHS App testing]({% link pages/using-nhs-notify/complete-your-testing.md %}). |
| 168 | + |
| 169 | +### If you're using NHS Notify API |
| 170 | + |
| 171 | +Your onboarding manager will ask for your: |
| 172 | + |
| 173 | +- production (PROD) application name |
| 174 | +- PROD application ID |
| 175 | +- consumer organisation name |
| 176 | +- JWKS resource URL (if you’re self-hosting) |
| 177 | +- key ID for JWKS and public key (if NHS Notify is hosting your keys via APIM) |
| 178 | + |
| 179 | +### If you’re using NHS Notify MESH |
| 180 | + |
| 181 | +Your onboarding manager will ask for your PROD Mesh Mailbox ID. |
| 182 | + |
| 183 | +## Next step |
| 184 | + |
| 185 | +Once you've completed all these tasks, you can check which NHS Notify features you'll need and register your interest. |
0 commit comments