API-åtkomst #

Ett API (Application Programming Interface) är ett sätt för olika mjukvarusystem att kommunicera med varandra. Your AI Connector-API:et låter dig (eller din utvecklare) automatiskt skapa kontakter, skicka meddelanden, hantera listor och ta emot inkommande meddelanden från anpassade kanaler — allt utan att använda kontrollpanelen.

Varför använda API:et? Om du vill ansluta appen till ett verktyg som inte har en inbyggd integration, eller om du behöver automatisera repetitiva uppgifter i stor skala, är API:et rätt väg att gå.

Generera din API-nyckel #

1. Klicka på Inställningar (kugghjulsikonen) i sidofältet till vänster.
2. I inställningsmenyn, under gruppen Integrationer, klickar du på API-nyckel.

3. Om du inte har en nyckel än, klicka på Generera API-nyckel.
4. Om du redan har en, visas den maskerad under Din nyckel. Om din nyckel stöder det, klicka på Visa för att avslöja den, och sedan Kopiera för att kopiera den — du kommer att se en bekräftelse i ett meddelandefält.
5. Förvara nyckeln på en säker plats — du behöver den för varje API-anrop.

Teammedlemmar: API-nyckeln tillhör kontots ägare, så om du är inloggad som en inbjuden teammedlem (inklusive en administratör) visas en notis istället för nyckeln. Logga in som kontots ägare för att visa, kopiera eller återskapa den — detta gäller även för begränsade nycklar.

Var hittar du den: API-nyckel är en egen sektion under Inställningar → Integrationer, separat från Webhooks. Om en guide eller en kollega ber dig leta efter nyckeln under “Webhooks”, titta i sektionen bredvid istället.

Begränsade nycklar: extra nycklar för specifika uppgifter #

Din huvudnyckel kan göra allt, så det är inte den nyckel du bör ge till en rapport, en klientpanel eller en separat sandbox- och utvecklingsmiljö. För det ändamålet skapar du begränsade nycklar (scoped keys) i kortet Begränsade nycklar, i samma API-nyckel-sektion under Din nyckel:

1. Klicka på Ny nyckel.
2. Ge den ett Namn som du känner igen senare, till exempel “Sandbox” eller “Acme klientpanel”.
3. Under Vad den kan se, markera endast de områden som behövs.
4. Under Vad den kan göra, behåll Skrivskyddad om inte verktyget måste göra ändringar. En nyckel som kan göra ändringar kan skicka meddelanden och redigera din konfiguration.
5. Ställ eventuellt in Förfrågningar per minut (dess egen gräns, så att den aldrig saktar ner dina andra integrationer) och ett Utgångsdatum.
6. Klicka på Skapa nyckel och kopiera den direkt. Begränsade nycklar visas bara en gång; om du tappar bort en, återkalla den och skapa en ny.

Du kan skapa så många du behöver. Varje nyckel i listan visar när den senast användes, och Återkalla nyckel gör att den slutar fungera omedelbart. Att skapa eller återkalla en begränsad nyckel påverkar aldrig din huvudnyckel. De fullständiga alternativen, inklusive nycklar begränsade till specifika underkonton, finns på sidan för API-nycklar i API-referensen.

Bas-URL #

Alla API-förfrågningar använder följande webbadress som bas:

https://api.youraiconnector.com/v1/

Autentisering #

Varje förfrågan måste innehålla din API-nyckel så att plattformen vet att det är du. Det enklaste sättet är att lägga till den i slutet av webbadressen:

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

Du kan också skicka nyckeln som en anropsrubrik (request header) istället för i URL:en (rekommenderas för produktion, så att nyckeln inte hamnar i serverloggar):

X-API-Key: YOUR_API_KEY

Authorization: Bearer YOUR_API_KEY

Alla förfrågningar måste använda en säker anslutning (HTTPS). Osäkra (HTTP) förfrågningar avvisas.

Letar du efter de fullständiga utvecklarguiderna? Den här sidan är en snabb introduktion som täcker de vanligaste åtgärderna. För kompletta, steg-för-steg-guider — för varje resurs, med exempel i cURL, JavaScript och Python — se Komma igång med API:et och API-referensen.

Vanliga API-åtgärder #

Skapa en kontakt #

Begäran:

POST https://api.youraiconnector.com/v1/contacts?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "firstName": "Jane",
  "lastName": "Smith",
  "phoneNumber": "+15551234567",
  "email": "jane@example.com"
}

Obligatoriska fält: ett phoneNumber (med landskod) krävs alltid för att skapa en kontakt. Enbart en e-postadress räcker inte — en förfrågan utan ett giltigt telefonnummer avvisas. E-postadressen är valfri.

Svar:

{
  "success": true,
  "data": {
    "message": "Successfully created new contact",
    "contactId": "abc123xyz",
    "listsAdded": []
  }
}

Spara data.contactId — du behöver det för anropet “Lägg till en kontakt i en lista”.

Lägg till en kontakt i en lista #

POST https://api.youraiconnector.com/v1/contacts/lists?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "contactId": "abc123xyz",
  "listId": "YOUR_LIST_ID"
}

Hitta en listas ID i appen under Kontakter → Listor, via listans radmeny (Kopiera list-ID).

Uppdatera en kontakt #

PUT https://api.youraiconnector.com/v1/contacts/YOUR_CONTACT_ID?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "customFields": { "company": "Acme Inc" }
}

Endast de fält du inkluderar ändras. Detta är också sättet att massladda värden för anpassade fält efter en import — se Anpassade fält, lead-profil & anteckningar. Fullständiga detaljer finns i Contacts API.

Skicka ett meddelande (anpassad kanal) #

POST https://api.youraiconnector.com/v1/send_custom_channel_message?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "customData": {
    "fromId": "external-contact-id",
    "customChannel": "my-channel",
    "body": "Hello Jane! Your order has been shipped.",
    "campaignId": "optional-campaign-id",
    "firstName": "Jane",
    "lastName": "Smith"
  }
}

Ta emot inkommande meddelanden (anpassad kanal) #

Ta emot meddelanden från externa system som en anpassad kanal. Det är så här integrationer som GoHighLevel skickar meddelanden till Your AI Connector. Se Anpassade kanaler för fullständig information.

POST https://api.youraiconnector.com/v1/incoming_custom_channel_message?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "customData": {
    "messageSid": "unique-message-id",
    "fromId": "external-contact-id",
    "toId": "your-user-id",
    "body": "Customer's message here",
    "channel": "custom",
    "status": "received"
  },
  "messageType": "text"
}

Översikt över tillgängliga åtgärder #

Hastighetsbegränsning #

API:et tillämpar hastighetsbegränsningar för att säkerställa plattformens stabilitet. Om du överskrider din gräns returneras 429 Too Many Requests — vänta och försök igen efter den tid som anges i svarshuvudena. För användningsfall med hög volym (massimport), använd den inbyggda importfunktionen eller skicka e-post till hi@youraiconnector.com för vägledning.

Bästa praxis #

• Förvara din API-nyckel säkert — använd en lösenordshanterare eller konfiguration på serversidan, aldrig klientkod som en webbplatsbesökare kan läsa.
• Inkludera alltid landsnumret i telefonnummer (+1 för USA, +44 för Storbritannien, +31 för Nederländerna).
• Hantera fel på ett smidigt sätt — kontrollera statuskoder och läs eventuella felmeddelanden som returneras.
• Hantera dubbletter — ett dubbelt telefonnummer returnerar { "success": false, "error_code": 409 } istället för en ny kontakt, med den befintliga kontaktens ID i contactId.
• Testa med en liten datamängd innan du kör massåtgärder.

Felmeddelanden #

{
  "error": {
    "code": "INVALID_PHONE",
    "message": "Phone number must include a valid country code."
  }
}

Nästa steg #

• Webhooks — ta emot realtidsaviseringar från appen (en separat sektion från din API-nyckel).
• Anslut AI-assistenter (MCP) — använd samma API-nyckel för att låta Claude styra ditt konto.
• Facebook Lead Forms — använd API:et med automatiseringsplattformar för att fånga leads.
• GoHighLevel-integration — ett exempel på en fullständig tvåvägs-API-integration.