28 september 2017

Live-auditing met de ContentKing API

Zoekmachines crawlen het web continu, 24/7 dag in, dag uit. Het is daarom essentieel dat je problemen zo snel mogelijk detecteert, zodat je ze kan oplossen voordat je er echt last van hebt. Om die reden is het van groot belang dat jouw tooling ook 24/7 jouw website in de gaten houdt. Daarom introduceren wij vandaag de ContentKing API.

ContentKing maakt gebruik van ingewikkelde algoritmen om te bepalen wanneer welke pagina gecheckt moet worden. Maar met de API ga je nog een stap verder: door de API te integreren in jouw publicatie workflow wordt de pagina waar je mee aan het werk bent direct geanalyseerd. Je publiceert een wijziging, en je ziet de resultaten ervan direct terug in ContentKing.

Deze, en soortgelijke functionaliteit, is de reden waarom ContentKing vooraan loopt wanneer het gaat om SEO auditing!

De ContentKing API koppelen

Het is niet lastig om de API te koppelen, maar je hebt wel iemand nodig met een technische achtergrond. Verwijs hen naar dit artikel en als er vragen zijn dan zijn wij volop beschikbaar om te ondersteunen.

ContentKing API – hoe te koppelen

Jouw unieke API token ophalen

Om te beginnen moet je de API token van jouw ContentKing account ophalen. Je vindt deze in de Account-sectie, onder het Team Profiel tabje.

API endpoint

Het idee is dat de ContentKing API wordt aangeroepen wanneer je een wijziging doet in jouw CMS, zoals bij het toevoegen, verwijderen of wijzigen van een pagina. Je doet dit middels een POST-request naar de volgende endpoint:

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

Hieronder vind je alle informatie over welke payload je moet verzenden.

API request headers

Wanneer je een request naar de API stuurt moet je de volgende request headers meesturen:

Authorization: token <plaats-youw-API-token-hier>
Content-Type: application/json

Let op: je moet de string “token” meegegeven, gevolgd door een spatie en jouw unieke API token.

API request body

Vervolgens moet je als request body een JSON object sturen, met daarin de volledige URL die ContentKing moet checken:

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

Let op: vergeet niet de volledige domeinnaam en protocol (http or httpsop te nemen.

API return codes

Nadat de request is verstuurd zal de ContentKing API één van de volgende antwoorden geven:

Succesvol verwerkt

200 OK

{
“status” : “ok”
}

Dit antwoord betekent dat de request succesvol is verwerkt en dat de pagina direct wordt gecontroleerd.

Autorisatie ontbreekt

401 Unauthorized

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

Dit antwoord betekent dat de request is ontvangen, maar dat de autorisatie token ontbreekt en het verzoek daardoor niet verwerkt kan worden. Voeg een Authorization header toe aan de request.

Autorisatie mislukt

401 Unauthorized

{
“code”: “auth_failed”,
“message”: “Authentication token is expired or invalid.”,
“errors”: []
}

Dit antwoord betekent dat de request niet afgehandeld kon worden omdat de verstrekte API token ongeldig is, of is verlopen.

Autorisatie ongeldig

422 Unknown Status

{
“code”: “auth_malformed”,
“message”: “Authorization HTTP header must conform to format described in docs.”,
“errors”: []
}

Dit antwoord betekent dat de request was ontvangen, maar dat de autorisatie niet in het juiste formaat was. Let erop dat de Authorization header correct wordt meegegeven.

Ongeldige URL

400 Bad Request

{
“code”: “invalid_url”,
“message”: “Invalid url format provided.”,
“errors”: []
}

Dit antwoord betekent dat je een ongeldige URL hebt opgegeven. Let erop dat je een volledige URL meestuurt, inclusief domeinnaam en protocol.

Onbekende website

400 Bad Request

{
“code”: “unknown_website”,
“message”: “Website isn’t registered in CK account.”,
“errors”: []
}

Dit antwoord betekent dat de website waarvoor je de request uitvoert niet voorkomt in het ContentKing account dat bij de API token hoort.

Hulp nodig bij het koppelen van onze API?

Indien je hulp nodig hebt bij het koppelen van de API, neem dan gerust contact met ons op. We helpen je graag op weg!

Waarom wachten? Probeer het direct.

Eindelijk doorhebben wat er werkelijk gebeurt op jouw website.
Gelieve een geldige domeinnaam (www.voorbeeld.nl) op te geven.