Inleiding

De Mentova REST API geeft Agency-accounts programmatische toegang tot al hun gegevens: merken, thema's, campagnes, zichtbaarheidsstatistieken, concurrenten, bronnen, kansen en doelgroepavatars.

Basis-URL voor elke aanvraag:

https://mentova.ai/api/v1

Het OpenAPI-schema is beschikbaar op /api/v1/openapi.json en kan rechtstreeks worden geïmporteerd in Postman, Insomnia of elke OpenAPI-compatibele tool.

Wie kan de API gebruiken

Toegang tot de API is voorbehouden aan het Agency-abonnement. Aanvragen met een sleutel van een ander abonnement krijgen een 403 PLAN_REQUIRED-fout.

Antwoordstructuur

Elk antwoord, of het nu een succes of een fout is, is een JSON-object.

Succes - enkele resource

{
  "data": { ... }
}

Succes - gepagineerde lijst

{
  "data": [ ... ],
  "total": 42,
  "limit": 50,
  "offset": 0
}

Fout

{
  "error": "Message lisible par un humain",
  "code": "CODE_MACHINE_LISIBLE"
}

Controleer altijd eerst de HTTP-statuscode. Het veld code identificeert het precieze fouttype voor programmatische verwerking - raadpleeg de foutenreferentie.

Authenticatie

Voor elke aanvraag is een API-sleutel vereist in de header X-API-Key (of Authorization: Bearer). Raadpleeg Authenticatie voor meer informatie over het genereren en verzenden van uw sleutels.