Logo
API Documentatie

API Documentatie

Welkom bij de API-documentatie! Hieronder vindt u informatie over verschillende eindpunten en hoe u ermee kunt communiceren.

Eindpunten

Contact

POST

https://[tenant].appointer.io/api/public/v1/contact

Deze API kan worden gebruikt voor "Neem contact met ons op" formulieren.

Header:

{
  headers: {
    "X-API-Key": "(Voer uw API-sleutel in)",
    "Content-Type": "application/json",
  },
}

Request Body:

{
  body: {
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "phoneDigits": "string", // Niet vereist
    "contactLanguage": "string",
    "note": "string",
  },
}

POST-verzoeken maken met JavaScript

Hier is een voorbeeld van het maken van een POST-verzoek met JavaScript met behulp van de Fetch API:


  fetch('https://palit.appointer.io/api/public/v1/contact', {
    method: 'POST',
    headers: {
      'X-API-Key': '0f521277-8e6c-4656-8343-9005345ffa2b',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneDigits": "string",
      "contactLanguage": "string",
      "note": "string"
    })
  })
  .then(response => response.json())
  .then(data => console.log(data))
  .catch((error) => {
    console.error('Error:', error);
  });

Responses:

Http Status: OK

{
  "success": true,
  "message": "Your message has been sent!"
}
Het verzoek is succesvol verwerkt. De verstrekte informatie is ontvangen door het bedrijf.

Subscription

POST

https://[tenant].appointer.io/api/public/v1/subscription

Deze API kan worden gebruikt om een abonnementsaanvraag voor de nieuwsbrief van het bedrijf te verzenden.

Header:

{
  headers: {
    "X-API-Key": "(Voer uw API-sleutel in)",
    "Content-Type": "application/json",
  },
}

Request Body:

{
  "email": "string",
}

POST-verzoeken maken met JavaScript

Hier is een voorbeeld van het maken van een POST-verzoek met JavaScript met behulp van de Fetch API:


  fetch('https://palit.appointer.io/api/public/v1/subscription', {
    method: 'POST',
    headers: {
      'X-API-Key': '0f521277-8e6c-4656-8343-9005345ffa2b',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "email": "string"
    })
  })
  .then(response => response.json())
  .then(data => console.log(data))
  .catch((error) => {
    console.error('Error:', error);
  });

Responses:

Http Status: OK

{
  "success": true,
  "message": "You have been subscribed!"
}
Het verzoek is succesvol verwerkt. De gebruiker zal een e-mail van het bedrijf ontvangen met aankomend nieuws.
Beste Praktijken
  • Vergeet niet de tenant-informatie van het bedrijf op te nemen in de URL. bijv: https://palit.appointer.io/public/v1...
  • Voeg altijd de API-sleutel toe aan de aanvraagheader met behulp van de X-API-KEY header naam.
  • Stuur altijd gegevens als een JSON-string en stel de"Content-Type" = "application/json".
  • Behandel serverreacties altijd correct. Controleer statuscodes en handel dienovereenkomstig fouten af.
  • Gebruik promises of async/await-syntaxis voor het afhandelen van asynchrone operaties.