Your AI Connector Docs

Godkendelse

Hver API-anmodning skal indeholde din API-nøgle, så Your AI Connector ved, at det er dig, og hvilken konto der skal handles på. Du kan sende nøglen på fire forskellige måder — de virker alle på ethvert slutpunkt, der accepterer API-nøgle-godkendelse, så vælg den, der passer bedst til din opsætning.

API-adgang er en betalt funktion. Hvis dit abonnement ikke inkluderer det, afvises anmodninger med en 403, selv når selve nøglen er gyldig — se Betalingsfunktionen herunder. For at generere en nøgle, se API-adgang.

Kun HTTPS. Alle anmodninger skal bruge en sikker forbindelse. Almindelige HTTP-anmodninger afvises, før godkendelsen overhovedet kører.

De fire metoder i overblik

Metode Transport Hvornår skal den bruges
Forespørgselsparameter ?apiKey=YOUR_API_KEY Hurtige tests og browser-URL’er
Header X-API-Key: YOUR_API_KEY Produktionsintegrationer
Bearer-header Authorization: Bearer YOUR_API_KEY Produktionsintegrationer
Firebase ID-token Authorization: Bearer <ID token> Kun førsteparts-app-sessioner

Når mere end én er til stede, vinder forespørgselsparameteren, derefter X-API-Key-headeren, og til sidst bearer-tokenet. I praksis sender du kun én.

1. Forespørgselsparameter — ?apiKey=

Tilføj din nøgle til slutningen af webadressen. Dette er den enkleste form og virker altid, hvilket gør den ideel til hurtige tests, scripts og ældre værktøjer.

cURL

curl "https://api.youraiconnector.com/v1/contacts?apiKey=YOUR_API_KEY"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/contacts?apiKey=YOUR_API_KEY");
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/contacts",
    params={"apiKey": "YOUR_API_KEY"},
)
data = res.json()

Bemærk: Webadresser ender i browserhistorik, serveradgangslogfiler og proxy-logfiler. Til alt udover en hurtig test bør du foretrække en af header-metoderne herunder, så din nøgle ikke skrives til disken i klartekst.

2. X-API-Key header

Send nøglen i en dedikeret header. Dette holder den ude af URL’en og er det anbefalede valg til produktion.

cURL

curl "https://api.youraiconnector.com/v1/contacts" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/contacts", {
  headers: {
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/contacts",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

3. Authorization: Bearer header

Du kan også sende nøglen som et standard bearer-token. Dette er praktisk, når din HTTP-klient eller dit framework allerede har indbygget understøttelse af Authorization-headere.

cURL

curl "https://api.youraiconnector.com/v1/contacts" \
  -H "Authorization: Bearer YOUR_API_KEY"

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/contacts", {
  headers: {
    Authorization: "Bearer YOUR_API_KEY",
  },
});
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/contacts",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)
data = res.json()

API’et skelner automatisk mellem din API-nøgle og et login-token, så denne metode fungerer nøjagtigt ligesom X-API-Key.

4. Firebase ID-token (kun førstepart)

Hvis du bygger en førsteparts-app, der logger brugere ind via Your AI Connector's eget login, kan du sende den indloggede brugers Firebase ID-token som et bearer-token i stedet for en API-nøgle:

Authorization: Bearer <Firebase ID token>

Tokenet verificeres ved hver anmodning og knyttes til den indloggede konto. Denne metode er kun til førsteparts-app-sessioner — du kan ikke generere disse tokens fra en ekstern integration, og der er ingen måde at få fat i et på uden at gennemgå det normale app-login. Til server-til-server- og tredjepartsintegrationer skal du bruge en API-nøgle (metode 1–3).

Hvornår skal man bruge hvad

  • Hurtige tests og engangsscripts → forespørgselsparameter (?apiKey=). Hurtigst at skrive, virker i en browser.
  • Produktionsintegrationer og server-til-server-kald → X-API-Key eller Authorization: Bearer YOUR_API_KEY. Holder nøglen ude af URL’er og logs.
  • Førsteparts-apps med en indlogget Your AI Connector-bruger → Authorization: Bearer <Firebase ID token>.

Nøgleomfang

Din konto har én hoved-API-nøgle — den, du finder under Indstillinger → Integrationer → API-nøgle. Den har fuld adgang til alt, hvad kontoen kan.

Du kan også oprette ekstra begrænsede nøgler: navngivne nøgler, der kun har adgang til de dele af API’et, du vælger, for eksempel en skrivebeskyttet nøgle begrænset til Analytics til et rapporteringsdashboard. En begrænset nøgle sendes på præcis samme måde som hovednøglen (ved brug af en af metoderne 1–3 ovenfor), men den bliver tjekket mod sine egne tilladelser ved hver anmodning:

  • Uden for sine tilladte områder afvises den. En skrivehandling med en skrivebeskyttet nøgle, eller et kald til en sektion, som nøglen ikke har fået adgang til, returneres som 403 — key_read_only eller key_scope_denied i feltet error_code. Tjekket er bevidst strengt: alt, der ikke tydeligt er inden for nøglens tilladte områder, afvises i stedet for at blive lukket igennem, så hvis du ser en af disse 403-fejl, dækker nøglen ganske enkelt ikke det pågældende slutpunkt.
  • Den har sit eget budget for hastighedsbegrænsning. En begrænset nøgle tælles separat fra din hovednøgle, så et travlt dashboard, der bruger en begrænset nøgle, kan ikke opbruge den kvote, som dine andre integrationer er afhængige af. Du vælger dette budget pr. minut, når du opretter nøglen.
  • Den kan ikke administrere API-nøgler. Kun kontoejeren — der er logget ind eller bruger hovednøglen — kan liste, oprette, redigere, rotere eller tilbagekalde nøgler. En begrænset nøgle kan aldrig oprette en nøgle med flere rettigheder end sig selv.

Se API-nøgler for at lære, hvordan du opretter, redigerer og tilbagekalder begrænsede nøgler.

Betalingsfunktionsspærring

API-adgang er en betalt funktion. Når dit abonnement ikke inkluderer den, bliver en anmodning med en ellers gyldig nøgle afvist med 403:

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

If you see this, check your plan or contact hi@youraiconnector.com. A missing or wrong key returns 401 instead:

{
  "success": false,
  "error_code": 401,
  "error": "Invalid API key"
}

Hold din nøgle sikker

  • Behandl nøglen som en adgangskode. Din hovednøgle giver fuld adgang til din konto. Hvis du har brug for at give en nøgle til et værktøj eller en person, der kun har brug for en del af adgangen, skal du i stedet oprette en begrænset nøgle — se Nøgleomfang.
  • Hold den på serversiden. Indlejr den aldrig i browser-JavaScript, en mobilapp-pakke eller anden kode, som en slutbruger kan læse.
  • Gem den i en secret manager eller i en konfiguration på serversiden, ikke i kildekoden.
  • Rotér den, hvis den lækkes. Generér en ny nøgle fra dashboardet eller kald POST https://api.youraiconnector.com/v1/api-keys/rotate — dette gør straks den gamle ugyldig. Se API-nøgler.
  • Brug altid HTTPS, så nøglen er krypteret under transport.

Næste skridt