Academy

De integratie van de CMS API in jouw publishing workflow laat je de pagina’s waaraan je werkt met prioriteit auditen zodat je sneller aanpassingen kunt maken. Dit staat je toe om onmiddelijk in ContentKing de resultaten te zien nadat er iets is veranderd.

Jouw CMS API token ophalen

Om de CMS API te gebruiken, is het nodig het CMS API token van jouw ContentKing account te verkrijgen. Je kunt deze vinden in de Account sectie, onder de Account Instellingen tab.

CMS API

API endpoint

Elke keer wanneer je iets verandert in jouw CMS, zoals het toevoegen, verwijderen, of veranderen van een pagina, is dient het CMS de ContentKing CMS API aan te roepen. Dit doe je door middel van een POST-request naar het volgende endpoint:

POST https://api.contentkingapp.com/v1/check_url

API request headers

Wanneer je een request maakt zul je de volgende request headers mee moeten sturen:

Authorization: token <place-your-API-token-here>
Content-Type: application/json

N.B.: geef de string “token” gevolgd door een spatie en het daadwerkelijke API token op.

API request body

Geef als request body de volledige URL van de desbetreffende pagina op in een JSON object:

{
	"url": "https://www.example.com/url-to-check/"
}

N.B.: vergeet niet de domeinnaam en protocol  (http of https) in je verzoek op te nemen.

API return codes

Nadat de aanroep verzonden is, zal de ContentKing API op een van de volgende manieren antwoorden:

Succesvol verwerkt

200 OK
{
	"status" : "ok"
}

Dit antwoord betekent dat het verzoek succesvol verwerkt is en dat de pagina onmiddellijk wordt gecontroleerd.

Authorisatie ontbreekt

401 Unauthorized
{
	"code": "auth_missing_token",
	"message": "Authentication token must be passed in Authorization HTTP header.",
	"errors": []
}

Dit antwoord betekent dat het verzoek ontvangen is, maar dat het authorisatie token ontbreekt en dat het daarom niet verwerkt kan worden.  Zorg ervoor dat de Authorization header op de juiste wijze ingesteld is.

Authorisatie mislukt

401 Unauthorized
{
	"code": "auth_failed",
	"message": "Authentication token is expired or invalid.",
	"errors": []
}

Als je dit antwoord krijgt, betekent het dat het verzoek niet verwerkt kon worden omdat het opgegeven API token ongeldig of vervallen is.

Authorization malformed

422 Unknown Status
{
	"code": "auth_malformed",
	"message": "Authorization HTTP header must conform to format described in docs.",
	"errors": []
}

Dit antwoord betekent dat het verzoek ontvangen is maar dat de authorisatie niet correct geformatteerd is.  Zorg ervoor dat de Authorization header juist ingesteld is.

Ongeldige URL

400 Bad Request
{
	"code": "invalid_url",
	"message": "Invalid url format provided.",
	"errors": []
}

Als je dit antwoord krijgt betekent het dat de opgegeven URL niet het juiste formaat heeft. Controleer of je een fully qualified URL hebt gestuurd, inclusief de domeinnaam en het protocol.

Onbekende website

400 Bad Request
{
	"code": "unknown_website",
	"message": "Website isn't registered in CK account.",
	"errors": []
}

Wanneer je dit antwoord krijgt dan bestaat de website waarvoor je het verzoek indient niet in het ContentKing account dat bij het API token hoort.

Hulp nodig bij de integratie van de CMS API?

Als jij of jouw developer hulp nodig heeft bij het integreren van de API, twijfel dan niet om contact op te nemen. Wij helpen je graag!

Probeer 14 dagen gratis

Binnen 20 seconden aan de slag

Gelieve een geldige domeinnaam (www.voorbeeld.nl) op te geven.
  • Geen credit card nodig
  • Geen installatie nodig
  • Geen verplichtingen