GEThttps://api.veriko.mx/v1/beneficiaries/imports/template

Descargar la plantilla de importación de beneficiarios

Audiencia
public
Autenticación
API key
Permiso
beneficiaries:create
Guía de uso →

Devuelve un archivo plantilla para la importación de beneficiarios en el formato solicitado, con encabezados en español o inglés y filas de ejemplo para CLABE, tarjeta y celular/DiMo. Sirve de punto de partida para la importación masiva.

El idioma de los encabezados se negocia con la cabecera Accept-Language; de forma predeterminada se entregan en español, acepta después encabezados en ambos idiomas de forma insensible a acentos.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
format*querystringobligatorio

Formato de la plantilla que se descarga. csv, xls, xlsx y txt contienen las columnas esperadas listas para rellenar; json contiene la misma forma para generar el archivo desde un programa.

p. ej. csv
Petición
curl -X GET 'https://api.veriko.mx/v1/beneficiaries/imports/template' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuestaGET /v1/beneficiaries/imports/template
CódigoClaseDescripciónCuerpo
2002xxArchivo plantilla generado. El Content-Type varía por formato (text/csv, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/vnd.ms-excel, text/plain, application/json).Sin cuerpo
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4034xxPermisos insuficientesErrorResponse
4224xxinvalid_format — el formato solicitado no está soportado.ErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Content-DispositionstringSugerencia de nombre de archivo para descarga.
Content-TypestringVaría según ?format (CSV / XLSX / XLS / TXT / JSON).
Errores de GET /v1/beneficiaries/imports/template
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
403forbidden

No tienes permiso para acceder a este recurso.

Envelope
meta.request_id
d5e6f7a8b9c0
422invalid_format

El formato debe ser uno de: csv, xlsx, xls, txt, json.

Envelope
meta.request_id
c5d6e7f8a9b0