Skip to main content
API - Getting Started
Updated over a week ago
  1. Create an account by clicking Signup Button. You can use any email to signup to the API Gateway. Does not need to be the same email as your Appointment Reminder account.

  2. This will send you an email. Click the link in the email to verify your account.

  3. Once signed in click "Products" in the header menu. Click on "Starter"

  4. Enter a "Subscription Name" (can be anything) in the new product subscription box. Click Subscribe.

  5. Take note of your "Primary Key" you will need to pass this through in each HTTP request in the header field name called "Ocp-Apim-Subscription-Key"

API Authentication.

The Appointment Reminder API uses Basic Auth to authenticate it is a combination of your login to Appointment Reminder and your API Key which can be found by logging into Appointment Reminder and going to Settings > Business Settings.

Test API Connection.

(Click to enlarge).

Did this answer your question?