Autenticación

Cada solicitud realizada al API incluirá un encabezado (header) de autenticación (X-API-Key) con una clave (api key) que sirve para verificar que la solicitud viene de infopiezas. Esta clave es única para su empresa y se intercambiará como parte del proceso de configuración.

Incluir el API key en cada llamada al API sirve varios propósitos:

  1. Autenticación: El API key actúa como un identificador único. Al incluirla en el encabezado de la solicitud, el API puede verificar que la solicitud proviene de infopiezas.

  2. Seguridad: Al requerir el API key en cada solicitud, se reduce el riesgo de que terceros no autorizados accedan al API.

Ejemplo de Uso

A continuación se muestra un ejemplo de cómo es incluído el header X-API-Key en una solicitud HTTP:

GET /api/endpoint
Host: api.example.com
X-API-Key: {api_key}

Es importante destacar que {api_key} debe ser reemplazada por la clave de API real proporcionada por infopiezas. El API de ejemplo presentado en este website utiliza el siguiente valor como api_key: test_apikey. En este caso, una llamada al API incluiría un header como el siguiente:

GET /api/endpoint
Host: api.example.com
X-API-Key: test_apikey
Note

Recomendamos el uso de un certificado SSL para que todas las llamadas a este API se hagan sobre HTTPS.