Información técnica

Información técnica de la API

Esta página describe los aspectos técnicos generales que debes conocer para realizar solicitudes a la API de Isifact.

Autenticación

Todos los endpoints requieren un token de autenticación. Debes enviarlo en el encabezado Authorization utilizando el esquema Bearer.

Authorization: Bearer tu_token

El token permite a la API identificar la empresa a la que corresponde la solicitud.

Formato de las respuestas

Por defecto, la API devuelve las respuestas en formato JSON-LD, que incluye información adicional sobre los recursos y sus relaciones.

Si necesitas recibir una respuesta en formato JSON simplificado, agrega el siguiente encabezado:

Accept: application/json

Ejemplo de encabezados

Authorization: Bearer tu_token
Accept: application/json

El encabezado Accept es opcional. Si lo omites, la API utilizará su formato de respuesta predeterminado, JSON-LD.

Entornos disponibles

La API dispone de dos entornos: pruebas y producción.

Entorno URL base
Pruebas https://demo-py.isifact.ec
Producción https://py.isifact.ec

Para realizar una solicitud, agrega la URL base del entorno correspondiente al endpoint.

Por ejemplo, para consultar la lista de impuestos (GET /api/taxes):

Entorno de pruebas

GET https://demo-py.isifact.ec/api/taxes

Entorno de producción

GET https://py.isifact.ec/api/taxes

Utiliza el entorno de pruebas para desarrollar y verificar tu integración. Cuando estés listo para operar, utiliza el entorno de producción con las credenciales correspondientes.

Métodos HTTP

Los endpoints utilizan los siguientes métodos HTTP para gestionar los recursos de la API.

Método Operación Descripción
POST Crear Crea un nuevo recurso. Generalmente, los datos del recurso se envían en el cuerpo de la solicitud.
GET Consultar Obtiene información de un recurso existente o recupera una colección de recursos.
PUT Modificar Actualiza un recurso existente. Los campos que deben enviarse dependen de la definición del endpoint.
DELETE Eliminar Solicita la eliminación de un recurso existente.

Ejemplos de uso

Tomando como referencia un recurso de facturas, los métodos se utilizan de la siguiente manera:

POST /api/invoices

Crea una nueva factura.

GET /api/invoices/123

Consulta la información de la factura con identificador 123.

PUT /api/invoices/123

Modifica la factura con identificador 123.

DELETE /api/invoices/123

Solicita la eliminación de la factura con identificador 123.

Los ejemplos anteriores ilustran el uso general de los métodos HTTP. La disponibilidad de cada operación y los campos requeridos dependen del endpoint específico.

Resumen

  • Autenticación: todas las solicitudes requieren Authorization: Bearer tu_token.
  • Formato predeterminado: JSON-LD.
  • Formato simplificado: agrega Accept: application/json.
  • Entorno de pruebas: https://demo-py.isifact.ec.
  • Entorno de producción: https://py.isifact.ec.
  • Crear recursos: utiliza POST.
  • Consultar recursos: utiliza GET.
  • Modificar recursos: utiliza PUT.
  • Eliminar recursos: utiliza DELETE.