Hoppa till innehåll
Svenska
Kontakta oss
  • Det finns inga förslag eftersom sökfältet är tomt.

API: Kom igång

Den här artikeln guidar dig kring att göra ditt första Insight API-anrop.

Steg 1: Hämta din API-token

För att komma igång med API:et, kontakta din Brilliant-representant. De kommer att konfigurera en API-token för din organisation med lämpliga behörigheter.

När du har fått din token, förvara den säkert – den ger åtkomst till din organisations data. Dela den inte i koddatabaser, e-postmeddelanden eller chattmeddelanden.

Steg 2: Autentisera

Alla API-förfrågningar kräver en JWT-bärartoken i Authorization rubriken:

Authorization: Bearer YOUR_API_TOKEN

 

Steg 3: Genomför ditt första anrop

Ett bra första anrop är att lista dina grupper för att kontrollera att allt fungerar.

Begäran:

GET /api/public/groups
Authorization: Bearer YOUR_API_TOKEN

Respons:

{
  "groups": [
    {
      "groupId": 1,
      "name": "Engineering",
      "externalId": "ENG-001",
      "categoryKey": "team",
      "isDeleted": false
    },
    {
      "groupId": 2,
      "name": "Marketing",
      "externalId": "MKT-001",
      "categoryKey": "team",
      "isDeleted": false
    }
  ]
}

 

Steg 4: Utforska vidare

När autentiseringen är klar; här är ett typiskt arbetsflöde för att hämta undersökningsresultat:

1. GET /api/public/surveys          → Find the survey you're interested in
2. GET /api/public/indexes?languageCode=en   → Get available indexes
3. GET /api/public/groups           → Get your organization's groups
4. GET /api/public/surveys/{id}/results      → Pull the results

 

Vanliga mönster

Filtrering efter gruppkategori

Grupper är organiserade i kategorier (t.ex. "team", "avdelning"). Du kan filtrera:

GET /api/public/groups?categoryKey=team


Lokaliserat innehåll

Index och frågor stöder flera språk. Skicka en ISO 639-1-språkkod:

GET /api/public/indexes?languageCode=sv
GET /api/public/questions?languageCode=en


Filtrering av undersökningsresultat

När du hämtar resultat kan du begränsa efter grupp, index eller fråga:

GET /api/public/surveys/42/results?groupId=1&indexId=5


Felhantering

Statuskod Betydelse
200 OK Begäran lyckades
400 Bad Request Ogiltiga parametrar (t.ex. okänd språkkod)
401 Unauthorized Saknat eller ogiltigt token
403 Forbidden Token har inte den behörighet som krävs

 

Nästa steg