Crea una API key

POST/api/v1/account/api-keys

Vencimiento por defecto 1 año, máximo 2 años. El secreto (key) se muestra solo en esta respuesta.

Cuerpo de la petición application/json

namestringobligatorio
Ejemplo: ERP producción
expires_in_monthsinteger· mínimo 1· máximo 24
Vence en N meses
Ejemplo: 3
expires_atstring · date-time
Fecha exacta (máximo 2 años)
never_expiresboolean
No vence; se puede deshabilitar o revocar. Sin ninguno de los tres, vence en un año
modestring· por defecto live
test: documentos de prueba (fro_test_…). live: producción (fro_live_…), solo si la cuenta está habilitada
Valores: test · live

Respuestas

201Key creada

idstring · uuid
namestring
key_prefixstring
Ejemplo: fro_live_ab12cd34
modestring
Valores: test · live
statusstring
Valores: active · disabled · expired · revoked
expires_atstring · date-time
null: no vence
last_used_atstring · date-time
created_atstring · date-time
keystring
Secreto completo. Solo se muestra una vez.
Ejemplo: fro_...

400Datos inválidos (details trae los campos)

codestring
Ejemplo: error.document.invalid
messagestring
errorsarray<object>
Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)
+ Ver 2 campos− Ocultar 2 campos
- fieldstring
  Ruta del campo en el JSON enviado
  Ejemplo: lines[0].quantity
- messagestring
  Ejemplo: Cantidad inválida: debe ser mayor que cero.
detailsarray<string>
Rutas de los campos inválidos (compatibilidad; usa errors)
request_idstring

401Falta la key o es inválida, está deshabilitada, vencida o revocada (error.missing_api_key, error.invalid_api_key, error.api_key.disabled, error.api_key.expired, error.api_key.revoked)

codestring
Ejemplo: error.document.invalid
messagestring
errorsarray<object>
Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)
+ Ver 2 campos− Ocultar 2 campos
- fieldstring
  Ruta del campo en el JSON enviado
  Ejemplo: lines[0].quantity
- messagestring
  Ejemplo: Cantidad inválida: debe ser mayor que cero.
detailsarray<string>
Rutas de los campos inválidos (compatibilidad; usa errors)
request_idstring