---
title: Puntos finales de la API
slug: puntos-finales-de-la-api
description: Descubra nuestro widget interno para una comunicación eficiente con la API. Comparta fácilmente las especificaciones de la API con miembros del equipo o clientes, incluyendo descripciones detalladas de la URL, parámetros, cookies, estructura de la solicit
createdAt: 2019-08-16T16:37:43.000Z
---

También reconocemos que no todas las empresas ofrecen APIs estandarizadas, por lo que creamos un widget interno para permitirte describir a tu equipo o clientes cómo es tu API.

Además, es muy útil cuando se trabaja junto con equipos externos, donde necesitas comunicar una especificación de API, y en lugar de proporcionar un archivo JSON, proporcionas un documento con este widget y permites que describa cualquier cosa, desde URL, Parámetros, Cookies, estructura de la Solicitud, estructura de la Respuesta, etc.

Puedes añadir uno escribiendo `(api)` en el editor o haciendo clic en el ícono de API en una nueva fila.

***

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://api.cakes.com/v1/cakes/:id",
  "name": "Cakes API",
  "method": "POST",
  "request": {
    "pathParameters": [
      {
        "kind": "required",
        "name": "id",
        "type": "string",
        "description": "ID of the cake to get, \n for free of course."
      }
    ],
    "queryParameters": [
      {
        "kind": "required",
        "name": "recipe",
        "type": "string",
        "description": "The API will do its best to find \n a cake matching the provided recipe."
      },
      {
        "kind": "required",
        "name": "gluten",
        "type": "boolean",
        "description": "Whether the cake should be \n gluten-free or not."
      }
    ],
    "headerParameters": [
      {
        "kind": "required",
        "name": "X-Auth-Token",
        "type": "string",
        "description": "Authentication token to track \n down who is emptying our stocks."
      }
    ],
    "formDataParameters": [],
    "bodyDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "mNZW47TKMdx5VBY_A7w-y",
        "code": "{\n    \"name\": \"Cake's name\",\n    \"recipe\": \"Cake's recipe name\",\n    \"cake\": \"Binary cake\"\n}",
        "language": "200"
      },
      {
        "id": "4txTa0_LO1TWO7FOVvFjj",
        "code": "{\n    \"message\": \"Ain't no cake like that.\"\n}",
        "language": "404"
      }
    ],
    "selectedLanguageId": "mNZW47TKMdx5VBY_A7w-y"
  },
  "examples": {
    "languages": [
      {
        "id": "5x2tfkoh7utDmGpv45DOA",
        "code": "fetch(\"https://api.cakes.com/v1/cakes/:id\", {\n  \"method\": \"POST\",\n  \"headers\": {\n    \"Accept\": \"application/json\"\n  }\n})\n.then(response => {\n  console.log(response);\n})\n.catch(err => {\n  console.error(err);\n});",
        "language": "javascript"
      },
      {
        "id": "sDqk0BbLTuvGBkZUjLsSv",
        "code": "const fetch = require('node-fetch');\n\nlet url = 'https://api.cakes.com/v1/cakes/:id';\nlet options = {\n  method: 'POST', \nheaders: {\n    Accept: 'application/json',\n  }\n};\nfetch(url, options)\n  .then(res => res.json())\n  .then(json => console.log(json))\n  .catch(err => console.error('error:' + err));",
        "language": "nodejs"
      },
      {
        "id": "G4ZGYdLoiDVDuj2yhZVt6",
        "code": "curl --request POST\n  --url https://api.cakes.com/v1/cakes/:id \n  --header 'Accept: application/json'",
        "language": "curl"
      },
      {
        "id": "s6TUVImaWbitxzfW9NgLm",
        "code": "import requests\n\nurl = \"https://api.cakes.com/v1/cakes/:id\"\nheaders = {\"Accept\": \"application/json\"}\nresponse = requests.request(\"GET\", url, headers=headers)\nprint(response.text)",
        "language": "python"
      },
      {
        "id": "AWzqoYUXp7zqI-QoObWAZ",
        "code": "const fetch = require('node-fetch');\n\nlet url = 'https://api.cakes.com/v1/cakes/:id';\nlet options = {method: 'POST', headers: {Accept: 'application/json'}};\nfetch(url, options)\n  .then(res => res.json())\n  .then(json => console.log(json))\n  .catch(err => console.error('error:' + err));",
        "language": "ruby"
      }
    ],
    "selectedLanguageId": "5x2tfkoh7utDmGpv45DOA"
  },
  "responses": [
    {
      "statusCode": 200,
      "description": "Cake successfully retrieved.",
      "jsonExample": "{\n    \"name\": \"Cake's name\",\n    \"recipe\": \"Cake's recipe name\",\n    \"cake\": \"Binary cake\"\n}"
    },
    {
      "statusCode": 404,
      "description": "Could not find a cake matching this query.",
      "jsonExample": "{\n    \"message\": \"Ain't no cake like that.\"\n}"
    }
  ],
  "description": "This endpoint allows you to obtain free cakes.",
  "currentNewParameter": {
    "label": "Path Parameter",
    "value": "pathParameters"
  },
  "hasTryItOut": true,
  "autoGeneratedAnchorSlug": "cakes-api",
  "legacyHash": "uR6Ob1_8v48ocI1ix7eYI"
}
```
:::

***

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://api.cakes.com",
  "name": "Add Cake",
  "method": "PUT",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [
      {
        "kind": "required",
        "name": "id",
        "type": "string",
        "description": "ID of the cake to get"
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "ujXlls271GisHxHhB4Vuq",
        "code": "",
        "language": "100"
      },
      {
        "id": "yJFwqLNqQZ1CqWmbDWVSV",
        "code": "{\n    \"name\": \"Cake's name\",\n}",
        "language": "200"
      },
      {
        "id": "veFsTjk4UScAb9yR7AK6Y",
        "code": "{\n    \"message\": \"Ain't no cake like that.\"\n}",
        "language": "404"
      }
    ],
    "selectedLanguageId": "ujXlls271GisHxHhB4Vuq"
  },
  "examples": {
    "languages": [
      {
        "id": "a7SyxH465CLSN6X0xbe4g",
        "code": "fetch(\"https://api.cakes.com\", {\n  \"method\": \"GET\",\n  \"headers\": {\n    \"Accept\": \"application/json\"\n  }\n})\n.then(response => {\n  console.log(response);\n})\n.catch(err => {\n  console.error(err);\n});",
        "language": "javascript"
      },
      {
        "id": "48WTucfgCh18gcuyiTY-h",
        "code": "A simple text.",
        "language": "none"
      }
    ],
    "selectedLanguageId": "a7SyxH465CLSN6X0xbe4g"
  },
  "description": "Add a new cake",
  "currentNewParameter": {
    "label": "Parámetro del cuerpo",
    "value": "bodyDataParameters"
  },
  "hasTryItOut": true,
  "autoGeneratedAnchorSlug": "add-cake",
  "legacyHash": "ZeFKbNEVwtwvB6gFp8448"
}
```
:::

Es MUY flexible y permite que su equipo describa en detalle cualquier tipo de endpoint HTTP.

También estamos trabajando para hacerlo interactivo, de modo que sus clientes puedan realizar la solicitud desde aquí.

***

::::LinkArray{contentSource="CUSTOM"}
:::LinkArrayItem{headerType="IMAGE" headerImage="https://api.archbee.com/api/optimize/K_JWZranXy1tD6qvlG2v6-C1IcmVcG0rx4ZLHX6X7V7-20250911-192557.png"}
:FontAwesome[]{icon="fa-solid fa-cubes"} &#x20;**&#x20;Encontrar otros bloques**

Descubre nuevas formas y bloques para crear páginas de documentación impresionantes y funcionales.

[Revisa todos los bloques](docId\:G2gQexIsuE2XnVGU6PWsT)&#x20;
:::

:::LinkArrayItem{headerType="IMAGE" headerImage="https://api.archbee.com/api/optimize/K_JWZranXy1tD6qvlG2v6-YRyGGWKsNS1ZZJa5XJy0z-20250911-192608.png"}
:FontAwesome[]{icon="fa-solid fa-headset"}**&#x20; ¿Necesitas ayuda?  ⬇️**

Usa la **burbuja** **de chat azul&#x20;**&#x65;n la esquina inferior derecha.

O prueba el **Chat de IA** (desde la barra de búsqueda) para respuestas rápidas.
:::

:::LinkArrayItem{headerType="IMAGE" headerImage="https://api.archbee.com/api/optimize/K_JWZranXy1tD6qvlG2v6-MS_ubDHlXgoktt4svD2rL-20250911-192619.png"}
:FontAwesome[]{icon="fa-solid fa-hand-holding-heart"}**&#x20;  Tu opinión importa**

Usa el siguiente formulario de comentarios, de forma anónima.

O haz una pregunta en la **sección de Preguntas y Respuestas** y nuestro equipo o la IA te dará una solución.
:::
::::

