Endpoints de la API. Especificación exacta de cada operación de la API v1 (parámetros, cuerpo, respuestas y ejemplos), generada del documento OpenAPI con el que se valida cada respuesta real. Los procedimientos completos están en Guías.

DELETE /clients/{id}

Eliminar un cliente

Da de baja el cliente; sus documentos anteriores se conservan.

Alcance (cliente de integración): clients:write
Permiso (token de usuario): exits.manage
Idempotency-Key: Opcional

Parámetros de ruta

id integer obligatorio

Identificador numérico del recurso.

Cabeceras

Idempotency-Key string

Llave única por operación (se recomienda un UUID v4). Reenviar la misma solicitud con la misma llave en las siguientes 24 horas devuelve la respuesta original sin repetir la operación.

Respuestas

204 Eliminado; sin cuerpo.

401 Falta el token o no es válido.

Cuerpo: el sobre de error.

402 La función no está en el plan de la empresa, o la cuenta está suspendida o cancelada.

Cuerpo: el sobre de error.

403 Al cliente le falta el alcance (missing_scope), al usuario el permiso (forbidden), o el token de usuario no tiene acceso a la ruta (client_not_allowed: aplicación móvil o usuario con verificación en dos pasos).

Cuerpo: el sobre de error.

404 El recurso no existe.

Cuerpo: el sobre de error.

409 Otra solicitud con la misma Idempotency-Key sigue en proceso.

Cuerpo: el sobre de error.

429 Se superó el límite por minuto. Reintente después de los segundos de Retry-After.

Cuerpo: el sobre de error.

Probar

Probar con una instancia

La solicitud sale del navegador hacia la instancia indicada; nada pasa por chainlink.mx. El token se conserva solo en esta pestaña.

Instancia https://.chainlink.mx Token de acceso

Obtener un token con un cliente de integración

Credenciales de Configuración › Clientes API (grant client_credentials). El secreto se usa una vez y no se guarda. Los tokens de usuario se obtienen fuera de la consola; ver Autenticación.

client_id client_secret

Alcances (scope)

id obligatorio

Esta solicitud modifica datos reales de la instancia.

Solicitud

curl -X DELETE "https://empresa.chainlink.mx/api/v1/clients/101" \
  -H "Authorization: Bearer $CHAINLINK_TOKEN" \
  -H "Accept: application/json" \
  -H "Idempotency-Key: $(uuidgen)"

<?php

$client = new \GuzzleHttp\Client();
$response = $client->request('DELETE', 'https://empresa.chainlink.mx/api/v1/clients/101', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('CHAINLINK_TOKEN'),
        'Accept' => 'application/json',
        'Idempotency-Key' => (string) \Ramsey\Uuid\Uuid::uuid4(),
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch('https://empresa.chainlink.mx/api/v1/clients/101', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.CHAINLINK_TOKEN}`,
    Accept: 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
});

console.log(response.status); // 204

import os
import uuid

import requests

response = requests.delete(
    "https://empresa.chainlink.mx/api/v1/clients/101",
    headers={
        "Authorization": f"Bearer {os.environ['CHAINLINK_TOKEN']}",
        "Accept": "application/json",
        "Idempotency-Key": str(uuid.uuid4()),
    },
)
print(response.status_code)  # 204

Respuesta

{
    "error": {
        "code": "unauthenticated",
        "message": "Falta el token de acceso o ya no es válido.",
        "doc_url": "https://chainlink.mx/developers/errores#unauthenticated",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Falta el token de acceso o ya no es válido."
}

{
    "error": {
        "code": "feature_not_in_plan",
        "message": "Función no disponible en tu plan actual.",
        "feature": "webhooks.enabled",
        "upgrade_url": "/billing/plans",
        "doc_url": "https://chainlink.mx/developers/errores#feature_not_in_plan",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Función no disponible en tu plan actual."
}

{
    "error": {
        "code": "missing_scope",
        "message": "El cliente no tiene el alcance products:write.",
        "scope": "products:write",
        "doc_url": "https://chainlink.mx/developers/errores#missing_scope",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "El cliente no tiene el alcance products:write."
}

{
    "error": {
        "code": "not_found",
        "message": "El recurso no existe.",
        "doc_url": "https://chainlink.mx/developers/errores#not_found",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "El recurso no existe."
}

{
    "error": {
        "code": "duplicate_in_flight",
        "message": "Esta solicitud ya se está procesando.",
        "doc_url": "https://chainlink.mx/developers/errores#duplicate_in_flight",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Esta solicitud ya se está procesando."
}

{
    "error": {
        "code": "rate_limited",
        "message": "Superaste el límite de solicitudes por minuto. Espera los segundos que indica Retry-After.",
        "doc_url": "https://chainlink.mx/developers/errores#rate_limited",
        "request_id": "req_01j9x2m4k7q8r5t6v3w0y1z2a3"
    },
    "errors": [],
    "message": "Superaste el límite de solicitudes por minuto. Espera los segundos que indica Retry-After."
}