Gå til indhold

REST API · v1

FalconCard REST API

Administrér kort, leads og analytics programmatisk — til CRM-synkronisering, automatisering og dine egne integrationer. Bearer-token-autentificering, JSON over HTTPS.

01

Kom godt i gang

Fra token til din første vellykkede forespørgsel i tre trin. API'et taler udelukkende JSON over HTTPS og følger gængse REST-konventioner — har du nogensinde integreret et HTTP API, vil du føle dig hjemme med det samme.

  1. Opret et token

    Åbn dit dashboard og naviger til Konto → API-tokens. Vælg de scopes, din integration har brug for, og kopiér tokenet med det samme — af sikkerhedshensyn vises det kun én gang i klartekst.

    Gå til API-tokens
  2. Sæt Bearer-headeren

    Send tokenet i Authorization-headeren ved hver forespørgsel. Tilføj Accept: application/json, så fejl også returneres som JSON.

    Authorization: Bearer DEIN_API_TOKEN
  3. Send din første forespørgsel

    Hent dine kort. Et vellykket kald returnerer HTTP 200 med et data-array og et meta-objekt til paginering:

cURL
curl https://falconcard.net/api/v1/cards \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Accept: application/json"
Svar · 200 OK
{
  "data": [
    {
      "id": 42,
      "slug": "max-mustermann-a1b2",
      "title": "Max Mustermann",
      "first_name": "Max",
      "last_name": "Mustermann",
      "status": "active",
      "is_public": true,
      "public_url": "https://falconcard.net/c/max-mustermann-a1b2",
      "updated_at": "2026-06-12T10:30:00+00:00"
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1
  }
}

Ser du denne form, er din autentificering korrekt. Hvert list-endpoint svarer med det samme data + meta skema — enkelte ressourcer returneres i et data-objekt uden meta.

Base-URL: https://falconcard.net/api/v1 · alle svar er JSON.

02

Autentificering

Hver forespørgsel autentificeres med et personligt adgangstoken (Laravel Sanctum) i headeren:

Authorization: Bearer DEIN_API_TOKEN

Du kan til enhver tid oprette og tilbagekalde tokens i dashboardet. Hvert token bærer ét eller flere scopes, der begrænser dets tilladelser.

Scopes

cards:read

List og læs kort

cards:write

Opret, opdatér og slet kort

leads:read

List og læs leads

analytics:read

Læs visnings- og klik-analytics

03

Koncepter

Fire byggesten, der fungerer ens for hvert endpoint — lær dem én gang, og de gælder overalt.

Versionering

Den aktuelle version er /api/v1 og er fastlagt i stien. Brydende ændringer udgives under et nyt præfiks (f.eks. /api/v2), så eksisterende integrationer forbliver stabile.

Forespørgselsformat

Skrive-endpoints forventer en JSON-body med Content-Type: application/json. Tidsstempler er ISO 8601 (UTC). Ukendte felter ignoreres, manglende valgfrie felter forbliver uændrede.

Rate-limiting

Enterprise-tokens må sende 1000 forespørgsler pr. minut. Hvert svar bærer X-RateLimit-Limit og X-RateLimit-Remaining. Ved overskridelse får du 429 Too Many Requests med en Retry-After-header (sekunder til nulstilling) — vent så længe, før du prøver igen.

Headers · hvert svar
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 994

Paginering

List-endpoints returnerer op til 15 elementer pr. side. Styr det med ?page= (1-baseret) og ?per_page= (maks. 100). Meta-objektet rapporterer current_page, last_page, per_page og total.

meta · hver liste
"meta": {
  "current_page": 2,
  "last_page": 7,
  "per_page": 15,
  "total": 98
}

Tilgængelighed. REST API'et er en del af Enterprise-planen. Tokens fra andre planer modtager 403.

04

Endpoint-reference

Fuld reference for alle ti endpoints, grupperet efter ressource. Hver definition holdes synkroniseret med OpenAPI-specifikationen — klar til import i Postman, Insomnia, Scalar eller din kodegenerator.

01

Cards

Opret, læs, opdatér og slet digitale visitkort.

GET
/api/v1/cards Scope cards:read

Lister kontoens kort, senest opdaterede først.

Parametre

Navn I Type Påkrævet Beskrivelse
page query integer nej Sidenummer (1-baseret).
per_page query integer nej Elementer pr. side, maks. 100.

Succes-svar

200 OK med et data-array af kort og et meta-objekt til paginering.

Fejlkoder

401403429
POST
/api/v1/cards Scope cards:write

Opretter et nyt kort. slug og title genereres automatisk. Plan-begrænsede felter tilpasses til tilladte værdier.

Parametre

Ingen parametre.

Forespørgsels-body application/json

Felt Type Begrænsninger Beskrivelse
first_name Påkrævet string maxLength 100 Fornavn.
last_name Påkrævet string maxLength 100 Efternavn.
job_title string | null maxLength 150 Stilling / jobtitel.
company string | null maxLength 150 Firmanavn.
bio string | null maxLength 1000 Kort beskrivelse / bio.
email string | null email · maxLength 255 Kontakt-e-mail (gyldigt e-mailformat).
phone string | null maxLength 50 Telefonnummer. Tilladte tegn: cifre, mellemrum og + - ( ) . /
website string | null uri · maxLength 500 Websted-URL.
booking_url string | null uri · maxLength 500 Link til tidsbestilling.
video_url string | null uri · maxLength 500 Video-URL. Kræver funktionen avanceret analytics, ellers ignoreret. plan-begrænset
address string | null maxLength 500 Postadresse.
social_links array | null maxItems 20 · platform: enum · url: http(s) uri or handle (completed) · maxLength 500 · label: maxLength 100 Liste over sociale medie-links (array af objekter).
design_config object | null — Design-overstyringer (farver, skrifttype, layout) som et objekt.
template_id string | null maxLength 50 ID på den skabelon, der skal bruges.
is_public boolean | null default true Om kortet er offentligt tilgængeligt. Standard true.
show_branding boolean | null — Vis FalconCard-branding. At skjule det kræver whitelabel-funktionen, ellers tvunget til true. plan-begrænset
show_lead_form boolean | null — Vis lead-formularen på kortet. Kræver lead-formular-funktionen, ellers tvunget til false. plan-begrænset
seo_title string | null maxLength 100 SEO-titel til det offentlige kort.
seo_description string | null maxLength 250 SEO-metabeskrivelse.
language string enum: de en bg cs da el es fr hr hu it nl pl pt ro sk sl sv uk Kortets primære sprog (f.eks. de).

Succes-svar

201 Created med det nye kort i data-objektet plus en message.

Fejlkoder

401403422429
GET
/api/v1/cards/{card} Scope cards:read

Returnerer et enkelt kort inklusive dets indsamlede leads.

Parametre

Navn I Type Påkrævet Beskrivelse
card path integer ja ID på kortet.

Succes-svar

200 OK med kortet (inklusive et indlejret leads-array) i data-objektet.

Fejlkoder

401403404429
PUT
/api/v1/cards/{card} Scope cards:write

Opdaterer et kort. Alle felter er valgfrie; kun angivne felter ændres. PUT og PATCH opfører sig identisk.

Parametre

Navn I Type Påkrævet Beskrivelse
card path integer ja ID på kortet.

Forespørgsels-body application/json

Felt Type Begrænsninger Beskrivelse
first_name string maxLength 100 Fornavn.
last_name string maxLength 100 Efternavn.
job_title string | null maxLength 150 Stilling / jobtitel.
company string | null maxLength 150 Firmanavn.
bio string | null maxLength 1000 Kort beskrivelse / bio.
email string | null email · maxLength 255 Kontakt-e-mail (gyldigt e-mailformat).
phone string | null maxLength 50 Telefonnummer. Tilladte tegn: cifre, mellemrum og + - ( ) . /
website string | null uri · maxLength 500 Websted-URL.
booking_url string | null uri · maxLength 500 Link til tidsbestilling.
video_url string | null uri · maxLength 500 Video-URL. Kræver funktionen avanceret analytics, ellers ignoreret. plan-begrænset
address string | null maxLength 500 Postadresse.
social_links array | null maxItems 20 · platform: enum · url: http(s) uri or handle (completed) · maxLength 500 · label: maxLength 100 Liste over sociale medie-links (array af objekter).
design_config object | null — Design-overstyringer (farver, skrifttype, layout) som et objekt.
template_id string | null maxLength 50 ID på den skabelon, der skal bruges.
is_public boolean | null — Om kortet er offentligt tilgængeligt. Standard true.
show_branding boolean | null — Vis FalconCard-branding. At skjule det kræver whitelabel-funktionen, ellers tvunget til true. plan-begrænset
show_lead_form boolean | null — Vis lead-formularen på kortet. Kræver lead-formular-funktionen, ellers tvunget til false. plan-begrænset
seo_title string | null maxLength 100 SEO-titel til det offentlige kort.
seo_description string | null maxLength 250 SEO-metabeskrivelse.
language string enum: de en bg cs da el es fr hr hu it nl pl pt ro sk sl sv uk Kortets primære sprog (f.eks. de).
status string | null enum: active, draft, archived Publiceringsstatus: active, draft eller archived.

Succes-svar

200 OK med det opdaterede kort i data-objektet plus en message.

Fejlkoder

401403404422429
PATCH
/api/v1/cards/{card} Scope cards:write

Opdaterer et kort. Alle felter er valgfrie; kun angivne felter ændres. PUT og PATCH opfører sig identisk.

Parametre

Navn I Type Påkrævet Beskrivelse
card path integer ja ID på kortet.

Forespørgsels-body application/json

Felt Type Begrænsninger Beskrivelse
first_name string maxLength 100 Fornavn.
last_name string maxLength 100 Efternavn.
job_title string | null maxLength 150 Stilling / jobtitel.
company string | null maxLength 150 Firmanavn.
bio string | null maxLength 1000 Kort beskrivelse / bio.
email string | null email · maxLength 255 Kontakt-e-mail (gyldigt e-mailformat).
phone string | null maxLength 50 Telefonnummer. Tilladte tegn: cifre, mellemrum og + - ( ) . /
website string | null uri · maxLength 500 Websted-URL.
booking_url string | null uri · maxLength 500 Link til tidsbestilling.
video_url string | null uri · maxLength 500 Video-URL. Kræver funktionen avanceret analytics, ellers ignoreret. plan-begrænset
address string | null maxLength 500 Postadresse.
social_links array | null maxItems 20 · platform: enum · url: http(s) uri or handle (completed) · maxLength 500 · label: maxLength 100 Liste over sociale medie-links (array af objekter).
design_config object | null — Design-overstyringer (farver, skrifttype, layout) som et objekt.
template_id string | null maxLength 50 ID på den skabelon, der skal bruges.
is_public boolean | null — Om kortet er offentligt tilgængeligt. Standard true.
show_branding boolean | null — Vis FalconCard-branding. At skjule det kræver whitelabel-funktionen, ellers tvunget til true. plan-begrænset
show_lead_form boolean | null — Vis lead-formularen på kortet. Kræver lead-formular-funktionen, ellers tvunget til false. plan-begrænset
seo_title string | null maxLength 100 SEO-titel til det offentlige kort.
seo_description string | null maxLength 250 SEO-metabeskrivelse.
language string enum: de en bg cs da el es fr hr hu it nl pl pt ro sk sl sv uk Kortets primære sprog (f.eks. de).
status string | null enum: active, draft, archived Publiceringsstatus: active, draft eller archived.

Succes-svar

200 OK med det opdaterede kort i data-objektet plus en message.

Fejlkoder

401403404422429
DELETE
/api/v1/cards/{card} Scope cards:write

Sletter et kort permanent.

Parametre

Navn I Type Påkrævet Beskrivelse
card path integer ja ID på kortet.

Succes-svar

200 OK med en bekræftelsesbesked.

Fejlkoder

401403404429
02

Leads

Læs kontakter indsamlet via lead-formularerne på dine kort.

GET
/api/v1/leads Scope leads:read

Lister leads indsamlet på tværs af alle kort, nyeste først. Filtrér til ét kort med card_id.

Parametre

Navn I Type Påkrævet Beskrivelse
card_id query integer nej Begræns til et enkelt kort, du ejer.
page query integer nej Sidenummer (1-baseret).
per_page query integer nej Elementer pr. side, maks. 100.

Succes-svar

200 OK med et data-array af leads og et meta-objekt.

Fejlkoder

401403429
GET
/api/v1/leads/{id} Scope leads:read

Returnerer et enkelt lead med en kompakt reference til det indsamlende kort.

Parametre

Navn I Type Påkrævet Beskrivelse
id path integer ja ID på leadet.

Succes-svar

200 OK med leadet i data-objektet.

Fejlkoder

401403404429
03

Analytics

Aggregeret visnings- og klikstatistik — på tværs af alle kort eller pr. kort.

GET
/api/v1/analytics/views Scope analytics:read

Aggregerede visningsmålinger på tværs af alle kort eller — via card_id — for et enkelt kort.

Parametre

Navn I Type Påkrævet Beskrivelse
card_id query integer nej Begræns til et enkelt kort, du ejer.
period query string (enum) nej Rapporteringsperiode. Tilladt: 7d, 14d, 30d, 90d, 365d. Standard 30d.

Succes-svar

200 OK med total_views, unique_views, views_per_day plus devices, countries og referrers i data-objektet.

Fejlkoder

401403422429
GET
/api/v1/analytics/clicks Scope analytics:read

Aggregerede klikmålinger på tværs af alle kort eller — via card_id — for et enkelt kort.

Parametre

Navn I Type Påkrævet Beskrivelse
card_id query integer nej Begræns til et enkelt kort, du ejer.
period query string (enum) nej Rapporteringsperiode. Tilladt: 7d, 14d, 30d, 90d, 365d. Standard 30d.

Succes-svar

200 OK med total_clicks, clicks_by_type og clicks_per_day i data-objektet.

Fejlkoder

401403422429

05

Kodeeksempler

Snippets til at kopiere og indsætte i cURL, JavaScript og Python. Erstat DEIN_API_TOKEN med dit rigtige token.

List kort
curl https://falconcard.net/api/v1/cards?per_page=15 \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Accept: application/json"
const res = await fetch("https://falconcard.net/api/v1/cards?per_page=15", {
  headers: {
    Authorization: "Bearer DEIN_API_TOKEN",
    Accept: "application/json",
  },
});
const { data, meta } = await res.json();
console.log(data, meta);
import requests

res = requests.get(
    "https://falconcard.net/api/v1/cards",
    params={"per_page": 15},
    headers={"Authorization": "Bearer DEIN_API_TOKEN"},
)
res.raise_for_status()
payload = res.json()
print(payload["data"], payload["meta"])
Opret et kort
curl -X POST https://falconcard.net/api/v1/cards \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Max",
    "last_name": "Mustermann",
    "job_title": "Geschäftsführer",
    "company": "FalconCard",
    "email": "max@example.com"
  }'
const res = await fetch("https://falconcard.net/api/v1/cards", {
  method: "POST",
  headers: {
    Authorization: "Bearer DEIN_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    first_name: "Max",
    last_name: "Mustermann",
    job_title: "Geschäftsführer",
    company: "FalconCard",
    email: "max@example.com",
  }),
});
const { data, message } = await res.json();
import requests

res = requests.post(
    "https://falconcard.net/api/v1/cards",
    headers={"Authorization": "Bearer DEIN_API_TOKEN"},
    json={
        "first_name": "Max",
        "last_name": "Mustermann",
        "job_title": "Geschäftsführer",
        "company": "FalconCard",
        "email": "max@example.com",
    },
)
res.raise_for_status()
print(res.json()["data"]["id"])
Vis leads
curl "https://falconcard.net/api/v1/leads?card_id=42&per_page=50" \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Accept: application/json"
const params = new URLSearchParams({ card_id: "42", per_page: "50" });
const res = await fetch(`https://falconcard.net/api/v1/leads?${params}`, {
  headers: {
    Authorization: "Bearer DEIN_API_TOKEN",
    Accept: "application/json",
  },
});
const { data } = await res.json();
import requests

res = requests.get(
    "https://falconcard.net/api/v1/leads",
    params={"card_id": 42, "per_page": 50},
    headers={"Authorization": "Bearer DEIN_API_TOKEN"},
)
res.raise_for_status()
for lead in res.json()["data"]:
    print(lead["name"], lead["email"])
Hent analytics
curl "https://falconcard.net/api/v1/analytics/views?card_id=42&period=30d" \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Accept: application/json"
const params = new URLSearchParams({ card_id: "42", period: "30d" });
const res = await fetch(`https://falconcard.net/api/v1/analytics/views?${params}`, {
  headers: {
    Authorization: "Bearer DEIN_API_TOKEN",
    Accept: "application/json",
  },
});
const { data } = await res.json();
console.log(data.total_views, data.unique_views);
import requests

res = requests.get(
    "https://falconcard.net/api/v1/analytics/views",
    params={"card_id": 42, "period": "30d"},
    headers={"Authorization": "Bearer DEIN_API_TOKEN"},
)
res.raise_for_status()
stats = res.json()["data"]
print(stats["total_views"], stats["unique_views"])

Eksempel: opret et kort

Forespørgsel · cURL
curl -X POST https://falconcard.net/api/v1/cards \
  -H "Authorization: Bearer DEIN_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Max",
    "last_name": "Mustermann",
    "job_title": "Geschäftsführer",
    "company": "FalconCard",
    "email": "max@example.com"
  }'
Svar · 201
{
  "data": {
    "id": 42,
    "slug": "max-mustermann-a1b2",
    "title": "Max Mustermann",
    "first_name": "Max",
    "last_name": "Mustermann",
    "status": "active",
    "is_public": true,
    "public_url": "https://falconcard.net/c/max-mustermann-a1b2",
    "created_at": "2026-06-12T10:30:00+00:00"
  },
  "message": "Karte erfolgreich erstellt."
}

06

Fejl

Hver fejl returnerer en message streng. Valideringsfejl (422) indeholder desuden et errors kort.

Status Name Beskrivelse Eksempel-body
401 Unauthorized Token mangler eller er ugyldigt.
{ "message": "Unauthenticated." }
403 Forbidden Planen inkluderer ikke API-adgang (kun Enterprise), eller tokenet mangler det krævede scope.
{
  "message": "API access is not available on your current plan. Please upgrade to Enterprise."
}
404 Not Found Ressourcen findes ikke eller tilhører ikke din konto.
{ "message": "Not found." }
422 Unprocessable Entity Validering mislykkedes — body indeholder et errors-kort (felt → beskeder).
429 Too Many Requests Rate-limit overskredet. Retry-After-headeren angiver ventetiden i sekunder.
{
  "message": "Too Many Requests",
  "retry_after": 37
}

422 indeholder desuden et errors-kort med felt → liste over beskeder:

422 Unprocessable Entity
{
  "message": "The last name field is required.",
  "errors": {
    "last_name": ["The last name field is required."],
    "email": ["The email must be a valid email address."]
  }
}

07

Maskinlæsbar specifikation

Hele API'et er dokumenteret som OpenAPI 3.1. Download specifikationen og importér den i Postman, Insomnia eller Scalar — eller generér typesikre klienter til dit sprog ud fra den.

Kompatibel med Postman · Insomnia · Scalar · OpenAPI-generatorer

Download openapi.json

08

Klar til at integrere?

Importér OpenAPI-specifikationen i dit værktøj, eller opret dit første API-token direkte i dashboardet.