Kom godt i gang med API’en #

Your AI Connector REST API’en giver dig mulighed for at bygge din egen integration oven på din konto. Du kan oprette og slå kontakter op, administrere kampagner, ofte stillede spørgsmål, opgaver og aftaler, sende beskeder, registrere webhooks, læse analyser og forbinde beskedkanaler — alt det, som dashboardet gør, styret af kode.

Dette er hovedsiden for API-dokumentationen. Hvis du forbinder Your AI Connector til et værktøj, der allerede har en indbygget integration, har du muligvis slet ikke brug for API’en. API’en er beregnet til tilpassede integrationer og automatisering i stor skala.

Basis-URL #

Alle anmodninger går til den samme base-webadresse, og alle stier i disse dokumenter er relative i forhold til den:

https://api.youraiconnector.com/v1

Så kampagne-endpointet er https://api.youraiconnector.com/v1/campaigns, kontakt-endpointet er https://api.youraiconnector.com/v1/contacts, og så videre.

Alle anmodninger skal bruge en sikker forbindelse (HTTPS). Almindelige HTTP-anmodninger afvises.

Sådan får du en API-nøgle #

API-adgang er en betalt funktion. Hvis dit abonnement ikke inkluderer den, returnerer hver anmodning en 403 med denne brødtekst:

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

Når API-adgang er aktiveret på dit abonnement, kan du generere en nøgle fra dashboardet. Den fulde trin-for-trin-vejledning findes i API-adgang — kort fortalt: gå til Indstillinger → Integrationer → API-nøgle for at generere eller gendanne din nøgle. API-nøgle er sin egen sektion under Integrationer, adskilt fra Webhooks, og den vises kun, når API-adgang er inkluderet i dit abonnement. Behandl nøglen som en adgangskode: den giver fuld adgang til din konto.

Godkendelse #

Du kan sende din API-nøgle på fire måder. De virker alle på ethvert endpoint, der accepterer API-nøgle-godkendelse.

Til produktion bør du foretrække en af header-formerne, så din nøgle aldrig ender i en serverlog eller browserhistorik. Forespørgselsparameter-formen virker altid og er den enkleste til en engangstest.

Se Godkendelse for en fuldstændig gennemgang af hver metode, med eksempler og vejledning i, hvornår du skal bruge hvad.

Din første anmodning #

Her er et komplet, fungerende kald, der viser kampagnerne på din konto. Det bruger din API-nøgle og returnerer de nyeste kampagner først.

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"])

Et vellykket svar ser således ud:

{
  "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- og fejlbeskeder #

Hvert JSON-svar indeholder et success-flag, så du kan forgrene din logik baseret på det uden at skulle parse statuskoder.

Et vellykket svar er success: true plus dataene for det pågældende slutpunkt (feltnavnet varierer — campaigns, contacts, data osv.):

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

Et mislykket svar er success: false med en læsbar error-besked og en numerisk error_code, der svarer til HTTP-statuskoden:

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

Tjek altid success (eller HTTP-statuskoden), før du læser dataene. Se Fejl & Sidetal for den fulde tabel over statuskoder og hvordan du navigerer gennem store resultatsæt.

Hastighedsbegrænsninger #

Autentificerede anmodninger er begrænset til 300 anmodninger pr. minut pr. API-nøgle. Der er også et bredere loft på 1.200 anmodninger pr. minut pr. konto, som tæller alle autentificerede anmodninger foretaget for den pågældende konto.

Hvis du overskrider en af grænserne, får du et 429 svar:

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

Hold en pause og prøv igen efter kort tid. Du kan også til enhver tid tjekke dit aktuelle forbrug med GET https://api.youraiconnector.com/v1/api-keys/usage, som returnerer, hvor mange anmodninger du har brugt i det nuværende vindue, og hvornår det nulstilles — nyttigt til at opbygge klient-side begrænsning (throttling). Se API-nøgler.

Ressourcevejledninger #

Ressourcegrupperne nedenfor har hver deres guide med de præcise stier, anmodningsfelter og svarformater.

Agenter, indgangspunkter og udsendelser #

AI-agenter, indgangspunkter og udsendelser findes alle i den publicerede OpenAPI-specifikation, så du kan gennemse deres præcise felter og køre live-forespørgsler mod dem i API-udforskeren. Hver har sin egen guide: AI-agenter, Indgangspunkter og Udsendelser.

Læsning af denne dokumentation som Markdown #

Hver side i denne dokumentation har en tvilling i ren Markdown: tag sidens adresse og tilføj /index.md til slutningen. Så denne side er også tilgængelig på https://docs.youraiconnector.com/api/getting-started/index.md, og den returneres som ren tekst i stedet for en webside — praktisk når du vil indsætte en side i en AI-assistent eller hente den ind i et script.

For at gennemgå hele sættet, start fra https://docs.youraiconnector.com/sitemap.xml, som viser hver side, vi udgiver. Bemærk, at dokumentationen bevidst holdes ude af søgemaskiner, så direkte hentning af disse adresser er måden at tilgå den på fra kode.

Der er endnu intet nøglebeskyttet dokumentations-endpoint og ingen bulk-download — Markdown-tvillingerne og sitemap’et udgør hele interfacet, og ingen af delene kræver en API-nøgle.

Næste skridt #

• Godkendelse — vælg den rigtige godkendelsesmetode til din integration.
• Fejl og paginering — håndter fejl og gennemse resultater side for side.
• API-adgang — generer din nøgle og se gennemarbejdede eksempler.