alphagov / notifications-net-client

.NET client for the GOV.UK Notify API
https://www.nuget.org/packages/GovukNotify/
MIT License
25 stars 20 forks source link

Remove API recommendation #95

Closed karlchillmaid closed 5 years ago

karlchillmaid commented 5 years ago

What problem does the pull request solve?

We're adding the following content to https://www.notifications.service.gov.uk/documentation:

Integrating directly with the API

We recommend using the client libraries rather than integrating directly with the API. There’s no documentation for using the API in this way. You’ll still need to read the client documentation to understand:

  • what the API client does
  • what development work you’ll need to do To send a message you’ll need to create an HTTPS request and add an authorisation header with your API key. The API key is encoded with JSON Web Tokens (JWT).

It seems unnecessary to repeat the recommendation in each of the client docs.