Orbit API
Référence API v1

Rechercher des centres d’intérêt

Paramètres, résultats et garanties de la recherche Orbit v1.

GET /v1/interests/search?q=<texte>&category=<catégorie>&limit=<1..50>

Paramètres

ParamètreObligatoireRègles
qouiUne occurrence, 1 à 100 caractères Unicode après trim.
categorynonUne à six occurrences uniques parmi games, movies, anime, series, music, books.
limitnonEntier de 1 à 50, valeur par défaut 20.

La recherche ignore la casse et les accents. Les caractères %, _ et \ sont traités comme du texte, pas comme des jokers SQL.

La recherche porte uniquement sur les libellés canoniques et ne renvoie que les intérêts publiés. Un libellé exact est classé avant un préfixe, puis avant les autres occurrences contenues. Répéter category lance une seule recherche, consomme une seule requête de quota et applique limit au résultat total des catégories demandées.

Exemple

curl --get \
  "${ORBIT_BASE_URL}/v1/interests/search" \
  --header "Authorization: Bearer ${ORBIT_API_KEY}" \
  --data-urlencode "q=zelda" \
  --data-urlencode "category=games" \
  --data-urlencode "category=anime" \
  --data-urlencode "limit=10"
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "label": "The Legend of Zelda",
      "category": "games"
    }
  ],
  "meta": {
    "apiVersion": "v1",
    "query": "zelda",
    "category": null,
    "categories": ["games", "anime"],
    "limit": 10,
    "returnedCount": 1
  }
}

L’UUID et le libellé ci-dessus sont illustratifs. Une liste data vide est un succès et signifie qu’aucun intérêt publié n’a été retenu.

Classement et pagination

La route renvoie un top-N classé par pertinence. Elle n’est ni exhaustive ni paginée, et l’ordre peut évoluer sans rupture de contrat. N’utilisez donc pas une position de résultat comme identifiant durable ; persistez uniquement l’UUID Orbit choisi.

La requête GET est réessayable sans effet de bord. Consultez les quotas et règles de nouvelle tentative.

Sur cette page