API
Nuestro API hace posible que cualquiera pueda crear cosas increíbles con las tiendas de Kometia. Puedes integrar Kometia a una aplicación existente, crear o extender funcionalidades o programar algún elemento personalizado para tu propia tienda.
Autenticación
Es requerido que todas las peticiones al API sean usando alguno de los métodos de autenticación. Para ello existen varias formas de hacerlo.
Apps o Proyectos públicos
Si requieres crear una app o desarrollar alguna integración que puedan ser usadas por otras personas o tiendas, necesitas utilizar el método de autenticación OAuth. Para eso, actualmente sólo proveemos acceso beta a crear credenciales, puedes registrarte al programa enviando un correo a beta@kometia.com contándonos qué es lo que pretendes construir.
Apps o Proyectos personales
Si deseas hacer una app o una integración personal, puedes hacerlo usando autenticación HTTP Basic, utilizando las credenciales que se encuentran en el panel de tu tienda en la sección de desarolladores.
Guía de autenticación con HTTP Basic
Versionamiento
La versión actual en Kometia es V1 y ésta debe de ser especificada en todos los endpoints (ej. /v1/products). Los cambios en la V1 del API serán de compatibilidad hacia atrás.
Limite de peticiones
Por el momento el limite por peticiones es de 60 peticiones por minuto. Por favor usa los endpoints de forma responsable y has uso de Webhooks para saber cuándo ocurre una actualización en lugar de sondear regularmente.
Endpoints
El API está diseñado de forma REST, lo que hace que nuestros URL's sean bastante intuitivos. Todas las respuestas por el momento son utilizandoJSON.
| Endpoint | Descripción |
|---|---|
| Archivos | Información sobre los archivos. |
| Artículos | Información sobre los artículos de los blogs. |
| Blogs | Información sobre los blogs. |
| Envíos | Información sobre los envíos. |
| Carritos | Información sobre los carritos de compra. |
| Categorías | Información sobre las categorías. |
| Checkouts | Información sobre los checkouts. |
| Clientes | Información sobre los clientes. |
| Colecciones | Información sobre las colecciones. |
| Direcciones | Información sobre las direcciones de los clientes. |
| Estados | Información sobre los estados. |
| Eventos | Información sobre los eventos. |
| Gateways | Información sobre los métodos de pago. |
| Órdenes | Información sobre las órdenes. |
| Países | Información sobre los países. |
| Páginas | Información sobre las páginas. |
| Productos | Información sobre los productos. |
| Reportes | Información sobre las ventas. |
| Skus | Información sobre los skus. |
Códigos de Estado
Nuestro API regresa codigos de estado HTTP por cada petición. Este es un resumen de los tipo de códigos que puedes recibir.
| Código | Status |
|---|---|
| 200 | Everything worked as expected. |
| 400 | Bad Request - missing or invalid parameters. |
| 401 | Unauthorized - invalid API credentials. |
| 402 | Request Failed - valid parameters, but the request failed. |
| 404 | Not Found - requested item doesn’t exist. |
| 5xx | Server Error - something is wrong on our end. |
Errores
Algunos errores pueden contener información adicional sobre el error enviado, aparte de código HTTP.
{
"errors": [
{
"id": "6d9be423-b177-4321-9043-54beffcfab93",
"status": 400,
"title": "Not Found",
"detail": "The requested resource could not be found but may be available again in the future."
}
]
}Paginación
Las peticiones que regresen múltiples objetos, tendrán información sobre la pagnación dentro del objeto meta.
{
"meta": {
"pagination": {
"current_page": 1,
"previous_page": null,
"next_page": null,
"per_page": 50,
"from": 1,
"to": 6,
"total_pages": 1,
"total_items": 6,
"links": {
"previous_page": null,
"next_page": null
}
}
},
"data": [
...
]
}Imágenes
Cualquier imagen que regrese nuestro API estará en el siguiente formato usando nuestro CDN.
https://cdn.kometia-static.com/kometia/images/ejemplo.pngEs probable que para tu App, requieras de una imagen en algún tamaño específico. Afortunadamente, Kometia utiliza tecnología de punta para poder modificar en tiempo real los formatos de las imágenes, en el que puedes cambiarla de tamaño, recortarla y darle distintos estilos.
https://cdn.kometia-static.com/kometia/images/ejemplo.png?w=200&h=200
https://cdn.kometia-static.com/kometia/images/ejemplo.png?w=200&fit=cropNota Este servicio es bastante flexible y abre enormes posibilidades. Por favor no hagas formatos excesivos de imágenes para no sobrecargar el servicio.