Saltar al contenido
Guías
EN
Referencia de API
estableapi_key:create

Crear clave de API

Crea una clave de API y devuelve su valor en texto plano una sola vez. No crea una aplicación OAuth, y las operaciones documentadas de Admin, Storefront y Auth no aceptan esta clave.

POST/v1/api-keys

Crea una clave de API y devuelve su valor en texto plano una sola vez. No crea una aplicación OAuth, y las operaciones documentadas de Admin, Storefront y Auth no aceptan esta clave.

Autorización

bearerAuth
AutorizaciónBearer <token>

Token de acceso OAuth 2.0 emitido por Ecomiq Auth.

Ubicación: header

Cuerpo de la solicitud

application/json

Definiciones TypeScript

Usa esta definición en TypeScript.

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "ERP de producción",    "isTestMode": false,    "scopes": [      "api_admin"    ],    "allowedIps": [      "203.0.113.10"    ],    "expiresAt": null,    "applicationUrl": "https://erp.example.com"  }'
{  "apiKey": {    "id": "string",    "name": "string",    "prefix": "string",    "keySuffix": "string",    "applicationUrl": null,    "isActive": true,    "isTestMode": true,    "expiresAt": null,    "lastUsedAt": null,    "scopes": [      "string"    ],    "allowedIps": [      "string"    ],    "createdOn": "2019-08-24T14:15:22Z",    "createdBy": null,    "userId": null  },  "plaintextKey": "string"}