Premiers pas

Référence de l'API

Intégrez les services de Nebux à vos propres applications

Vue d'ensemble

L'API de Nebux vous permet d'interagir par programmation avec tous les services de Nebux. La plupart des opérations sont exposées via un unique endpoint GraphQL ; le service d'inférence d'IA propose en plus une API REST compatible avec OpenAI.

Endpoint GraphQL

URL

https://api.nebux.cloud

MethodPOST

Content-Typeapplication/json

Authentification

Toutes les requêtes doivent inclure une clé API valide comme token Bearer dans l'en-tête Authorization. Une clé a exactement les permissions qui lui ont été accordées, et tout ce qui se trouve en dehors répond comme si cela n'existait pas. Vous pouvez gérer vos clés API et ce que chacune peut faire depuis le tableau de bord.

HeaderAuthorization: Bearer your-api-key

API keysGérer les clés API

Format de la requête

Les requêtes GraphQL sont des objets JSON avec un champ query (le document GraphQL) et un champ variables facultatif.

body.json

{
  "query": "query GetIssue($id: ID!) { issue(id: $id) { id friendlyId title status } }",
  "variables": { "id": "rprdbtyvc51ys7g7xq9xwra8cm" }
}

Faire une requête

L'API GraphQL de Nebux fonctionne avec n'importe quel client HTTP. Aucune bibliothèque particulière n'est requise : envoyez simplement une requête POST avec un corps JSON. Les exemples ci-dessous montrent comment faire une requête GraphQL simple dans le langage de votre projet.

index.ts

const res = await fetch("https://api.nebux.cloud", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer your-api-key",
  },
  body: JSON.stringify({
    query: `query GetIssue($id: ID!) { issue(id: $id) { id friendlyId title status } }`,
    variables: { id: "rprdbtyvc51ys7g7xq9xwra8cm" },
  }),
})

const { data } = await res.json()
console.log(data.issue.title)

Astuce : Si vous préférez un client GraphQL typé, des bibliothèques comme graphql-request (JS/TS) ou gql (Python) fonctionnent directement avec cet endpoint.