Aan de slag met de API #

Met de Your AI Connector REST API kun je je eigen integratie boven op je account bouwen. Je kunt contacten aanmaken en opzoeken, campagnes, veelgestelde vragen, taken en afspraken beheren, berichten versturen, webhooks registreren, analyses lezen en berichtenkanalen koppelen — alles wat het dashboard doet, aangestuurd door code.

Dit is de centrale pagina voor de API-documentatie. Als je Your AI Connector koppelt aan een tool die al een ingebouwde integratie heeft, heb je de API wellicht helemaal niet nodig. De API is bedoeld voor aangepaste integraties en automatisering op schaal.

Basis-URL #

Elk verzoek gaat naar hetzelfde basiswebadres en alle paden in deze documentatie zijn hieraan gerelateerd:

https://api.youraiconnector.com/v1

Dus het eindpunt voor campagnes is https://api.youraiconnector.com/v1/campaigns, het eindpunt voor contacten is https://api.youraiconnector.com/v1/contacts, enzovoort.

Alle verzoeken moeten gebruikmaken van een beveiligde verbinding (HTTPS). Gewone HTTP-verzoeken worden geweigerd.

Een API-sleutel verkrijgen #

API-toegang is een betaalde functie. Als je abonnement dit niet bevat, retourneert elk verzoek een 403 met de volgende inhoud:

{
  "success": false,
  "error_code": 403,
  "error": "This action requires the \"api_access\" feature, which is not enabled for this account."
}

Zodra API-toegang is ingeschakeld voor uw abonnement, kunt u een sleutel genereren via het dashboard. De volledige stapsgewijze handleiding vindt u in API-toegang — kort gezegd: ga naar Instellingen → Integraties → API-sleutel om uw sleutel te genereren of opnieuw te genereren. API-sleutel is een eigen sectie onder Integraties, los van Webhooks, en verschijnt pas zodra API-toegang is ingeschakeld voor uw abonnement. Behandel de sleutel als een wachtwoord: deze verleent volledige toegang tot uw account.

Authenticatie #

Je kunt je API-sleutel op vier manieren verzenden. Ze werken allemaal op elk eindpunt dat authenticatie via een API-sleutel accepteert.

Geef voor productie de voorkeur aan een van de header-vormen, zodat je sleutel nooit in een serverlogboek of browsergeschiedenis terechtkomt. De queryparameter-vorm werkt altijd en is het eenvoudigst voor een eenmalige test.

Zie Authenticatie voor een volledig overzicht van elke methode, met voorbeelden en richtlijnen over wanneer je welke methode gebruikt.

Je eerste verzoek #

Hier is een volledige, werkende aanroep die de campagnes in je account weergeeft. Deze gebruikt je API-sleutel en toont de meest recente campagnes eerst.

cURL

curl "https://api.youraiconnector.com/v1/campaigns?apiKey=YOUR_API_KEY&limit=10"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/campaigns?limit=10", {
  headers: {
    "X-API-Key": "YOUR_API_KEY",
  },
});

const data = await res.json();
console.log(data.campaigns);

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/campaigns",
    params={"limit": 10},
    headers={"X-API-Key": "YOUR_API_KEY"},
)

data = res.json()
print(data["campaigns"])

Een geslaagd antwoord ziet er als volgt uit:

{
  "success": true,
  "campaigns": [
    {
      "id": "NBCXrhqGPSFsd6MV7pRo",
      "name": "Inbound WhatsApp Leads",
      "type": "Incoming from Unknown Contacts",
      "status": "Live",
      "enabled": true,
      "archived": false,
      "created_at": 1700000000000,
      "ai_mode": true,
      "language": "en",
      "enabled_channels": ["whatsapp", "instagram"]
    }
  ],
  "next_cursor": null
}

Succes- en foutmeldingen #

Elk JSON-antwoord bevat een success-vlag, zodat je hierop kunt vertakken zonder statuscodes te hoeven parseren.

Een geslaagd antwoord is success: true plus de gegevens voor dat eindpunt (de veldnaam varieert — campaigns, contacts, data, enzovoort):

{
  "success": true,
  "campaigns": []
}

Een mislukt antwoord is success: false met een leesbaar error-bericht en een numerieke error_code die overeenkomt met de HTTP-status:

{
  "success": false,
  "error": "Invalid cursor",
  "error_code": 400
}

Controleer altijd success (of de HTTP-status) voordat je de gegevens leest. Zie Fouten & Paginering voor de volledige tabel met statuscodes en hoe je door grote resultatensets bladert.

Snelheidslimieten #

Geverifieerde verzoeken zijn beperkt tot 300 verzoeken per minuut per API-sleutel. Er is ook een ruimer plafond van 1.200 verzoeken per minuut per account, waarbij elk geverifieerd verzoek voor dat account wordt meegeteld.

Als u een van beide limieten overschrijdt, ontvangt u een 429-antwoord:

{
  "success": false,
  "error_code": 429,
  "error": "Rate limit exceeded. Please try again later."
}

Wacht even en probeer het na een korte pauze opnieuw. Je kunt je huidige verbruik ook op elk gewenst moment controleren met GET https://api.youraiconnector.com/v1/api-keys/usage, die teruggeeft hoeveel verzoeken je in het huidige venster hebt gebruikt en wanneer dit wordt gereset — handig voor het bouwen van client-side throttling. Zie API-sleutels.

Resourcegidsen #

De onderstaande resourcegroepen hebben elk hun eigen handleiding met de exacte paden, aanvraagvelden en antwoordstructuren.

Agents, Toegangspunten en Uitzendingen #

AI Agents, Entry Points en Broadcasts staan allemaal in de gepubliceerde OpenAPI-specificatie, zodat je hun exacte velden kunt bekijken en live verzoeken kunt uitvoeren in de API explorer. Elk heeft zijn eigen handleiding: AI Agents, Entry Points en Broadcasts.

Deze documentatie lezen als Markdown #

Elke pagina in deze documentatie heeft een Markdown-tegenhanger: neem het adres van de pagina en voeg /index.md toe aan het einde. Deze pagina is dus ook beschikbaar op https://docs.youraiconnector.com/api/getting-started/index.md en wordt als platte tekst geretourneerd in plaats van als webpagina — handig wanneer je een pagina in een AI-assistent wilt plakken of in een script wilt ophalen.

Om de volledige set te doorlopen, begin je bij https://docs.youraiconnector.com/sitemap.xml, waar elke pagina die we publiceren wordt vermeld. Let op: de documentatie wordt bewust buiten zoekmachines gehouden, dus het rechtstreeks ophalen van deze adressen is de manier om deze vanuit code te bereiken.

Er is nog geen met een sleutel beveiligd documentatie-eindpunt en geen bulkdownload — de Markdown-tegenhangers en de sitemap vormen de volledige interface, en voor geen van beide is een API-sleutel nodig.

Volgende stappen #

• Authentication — kies de juiste authenticatiemethode voor je integratie.
• Errors & Pagination — fouten afhandelen en door resultaten bladeren.
• API Access — je sleutel genereren en uitgewerkte voorbeelden bekijken.