Primeros pasos

Referencia de la API

Integra los servicios de Nebux desde tus propias aplicaciones

Descripción general

La API de Nebux te permite interactuar con todos los servicios de Nebux de forma programática. La mayoría de las operaciones se exponen a través de un único endpoint de GraphQL; el servicio de inferencia de IA también ofrece una API REST compatible con OpenAI.

Endpoint GraphQL

URL

https://api.nebux.cloud

MethodPOST

Content-Typeapplication/json

Autenticación

Todas las solicitudes deben incluir una clave de API válida como token de tipo Bearer en la cabecera Authorization. Una clave tiene exactamente los permisos que se le concedieron, y todo lo que quede fuera responde como si no existiera. Puedes gestionar tus claves de API y lo que puede hacer cada una desde el panel.

HeaderAuthorization: Bearer your-api-key

API keysGestionar claves de API

Formato de petición

Las peticiones de GraphQL son objetos JSON con un campo query (el documento GraphQL) y un campo variables opcional.

body.json

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

Hacer una petición

La API GraphQL de Nebux funciona con cualquier cliente HTTP. No se requiere ninguna biblioteca especial: simplemente envía una solicitud POST con un cuerpo JSON. Los ejemplos a continuación muestran cómo hacer una consulta sencilla en el lenguaje de tu proyecto.

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)

Consejo: Si prefieres un cliente de GraphQL con tipos, bibliotecas como graphql-request (JS/TS) o gql (Python) funcionan de forma nativa con este endpoint.