Administrasjon

API-referanse

Enterprise

Integrer organisasjonens data med eksterne verktøy, analyseplattformer og tilpassede applikasjoner ved hjelp av Enkelt.ai REST API.

Basis-URL

https://enkelt.ai/api/public/v1

Alle API-forespørsler skal gjøres til denne basis-URL-en. HTTPS er påkrevd.

Rask oversikt

Enkelt.ai API gir programmatisk tilgang til organisasjonens data. Bruk den til å bygge tilpassede integrasjoner, synkronisere data med eksterne systemer, eller lage automatiserte arbeidsflyter.

Bearer-autentisering

Autentiser med API-nøkler ved hjelp av Authorization-headeren.

Hastighetsbegrenset

Forespørsler er hastighetsbegrenset per nivå. Enterprise får 1000 forespørsler/min.

JSON-format

Alle forespørsler og svar bruker JSON. UTF-8-koding er påkrevd.

Autentisering

Alle API-forespørsler krever autentisering med et Bearer-token. Generer API-nøkler fra Etterlevelse > API-nøkler-seksjonen i dashboardet ditt.

Authorization-header

HTTP Header
Authorization: Bearer sk_live_your_api_key_here

Eksempel på forespørsel

cURL
curl -X GET "https://enkelt.ai/api/public/v1/players" \
  -H "Authorization: Bearer sk_live_your_api_key" \
  -H "Content-Type: application/json"

Hold API-nøkkelen din sikker

Aldri eksponer API-nøkkelen din i klientside-kode, offentlige repositorier eller logger. Behandle den som et passord. Hvis den blir kompromittert, tilbakekall den umiddelbart og generer en ny.

Hastighetsbegrensning

API-forespørsler er hastighetsbegrenset for å sikre rettferdig bruk og systemstabilitet. Grenser gjelder per API-nøkkel og nullstilles på rullerende basis.

Free
Forespørsler / minutt
10
Forespørsler / dag
100
Basic
Forespørsler / minutt
60
Forespørsler / dag
1,000
Pro
Forespørsler / minutt
300
Forespørsler / dag
10,000
Enterprise
Forespørsler / minutt
1,000
Forespørsler / dag
100,000

Hastighetsbegrensning-headere

Hvert svar inkluderer headere som viser din nåværende hastighetsbegrensningsstatus:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 987
X-RateLimit-Reset: 1703275200

Tilgjengelige endepunkter

API-et gir tilgang til følgende ressurser. Alle endepunkter krever autentisering og respekterer tillatelsene tildelt API-nøkkelen din.

Spillere

GET
/playersList alle spillere i organisasjonen din
GET
/players/:idHent en spesifikk spiller etter ID
POSTplayers:write
/playersOpprett en ny spiller
PATCHplayers:write
/players/:idOppdater en eksisterende spiller

Rollevalidering

Rolle-feltet må være en gyldig rolle for lagets spill. Hvis ingen lag er tildelt, valideres roller mot "Other" spillroller.

LoL: Top, Jungle, Mid, ADC, Support, Coach, Analyst, Substitute
Valorant: Duelist, Initiator, Controller, Sentinel, Flex, IGL, Coach, Analyst, Substitute
CS2: Entry Fragger, AWPer, Rifler, Support, Lurker, IGL, Coach, Analyst, Substitute
Other: Player, Captain, Coach, Analyst, Manager, Substitute

Lag og timeplan

GET
/teamsList alle lag i organisasjonen din
GET
/rosterHent lagoppstillingsinformasjon
GET
/scheduleHent kommende timeplan og kamper

Prospekter

GET
/prospectsList alle prospekter i rekrutteringspipelinen din
GET
/prospects/:idHent et spesifikt prospekt
POSTprospects:write
/prospectsLegg til et nytt prospekt
PATCHprospects:write
/prospects/:idOppdater prospektdetaljer

Kontrakter

GET
/contractsList alle kontrakter
GET
/contracts/:idHent kontraktdetaljer
GET
/contracts/expiringHent kontrakter som snart utløper

Svarformat

Alle API-svar følger en konsistent JSON-struktur. Vellykkede svar inkluderer data og metadata, mens feil inkluderer feilkoder og meldinger.

Vellykket svar

200 OK
{
  "success": true,
  "data": {
    "id": "player_abc123",
    "ign": "TenZ",
    "realName": "Tyson Ngo",
    "game": "valorant",
    "role": "duelist",
    "country": "CA",
    "createdAt": "2024-01-15T10:30:00Z"
  },
  "meta": {
    "count": 1,
    "requestId": "req_xyz789",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

Feilsvar

4xx / 5xx
{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded",
    "status": 429
  }
}

Feilkoder

Når en feil oppstår, returnerer API-et en passende HTTP-statuskode og en JSON-body med detaljer om feilen.

INVALID_API_KEY401

API-nøkkelen mangler eller er feilformatert

KEY_REVOKED403

API-nøkkelen har blitt tilbakekalt

KEY_EXPIRED403

API-nøkkelen har utløpt

INSUFFICIENT_PERMISSIONS403

API-nøkkelen mangler nødvendige tillatelser for dette endepunktet

VALIDATION_ERROR400

Foresporselen mangler obligatoriske felt eller inneholder ugyldige verdier

INVALID_PARAMETER400

En sporreparameter har en ugyldig verdi

INVALID_ROLE400

Rollen er ikke gyldig for lagets spill. Se gyldige roller per spill

RATE_LIMIT_EXCEEDED429

For mange forespørsler. Vent og prøv igjen

NOT_FOUND404

Den forespurte ressursen ble ikke funnet

INTERNAL_ERROR500

En uventet serverfeil oppstod

Tillatelser og omfang

API-nøkler kan tildeles spesifikke tillatelser for å begrense hvilke data de har tilgang til. Bruk alltid minimum nødvendige tillatelser for integrasjonen din.

players:read

Se spillerprofiler, statistikk og grunnleggende informasjon

players:write

Opprett og oppdater spillerprofiler

prospects:read

Se prospekter i rekrutteringspipelinen din

prospects:write

Legg til og oppdater prospekter

contracts:read

Se kontraktdetaljer og utløpsdatoer

teams:read

Se lag og lagdetaljer

roster:read

Se lagoppstillingsinformasjon og spillertildelinger

schedule:read

Se kommende timeplan, kamper og hendelser

Kodeeksempler

Her er eksempler på hvordan du bruker API-et i populære programmeringsspråk.

JavaScript / Node.js

JavaScript / Node.js
const response = await fetch('https://enkelt.ai/api/public/v1/players', {
  headers: {
    'Authorization': 'Bearer sk_live_your_api_key',
    'Content-Type': 'application/json'
  }
});

const { data } = await response.json();
console.log(data); // Array of players

Python

Python
import requests

response = requests.get(
    'https://enkelt.ai/api/public/v1/players',
    headers={
        'Authorization': 'Bearer sk_live_your_api_key',
        'Content-Type': 'application/json'
    }
)

data = response.json()
print(data['data'])  # List of players

Beste praksis

  • Bruk miljøvariabler for å lagre API-nøkkelen din, aldri hardkod den
  • Implementer eksponentiell tilbaketrekning når du mottar hastighetsbegrensningsfeil (429)
  • Bufre svar når det er mulig for å redusere API-kall
  • Bruk minimum nødvendige tillatelser for API-nøkkelen din
  • Roter API-nøkler periodisk for bedre sikkerhet
  • Overvåk API-bruken din i dashboardet for å unngå å nå grensene

Trenger du hjelp?

Sjekk API-nøkler-dashboardet for bruksanalyse og logger. Hvis du opplever problemer, kontakt supportteamet vårt med forespørsels-ID-en fra feilsvaret.