Download the PHP package astroselling/jupiter-sdk without Composer
On this page you can find all versions of the php package astroselling/jupiter-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download astroselling/jupiter-sdk
More information about astroselling/jupiter-sdk
Files in astroselling/jupiter-sdk
Package jupiter-sdk
Short Description Astroselling´s integration SDK
License MIT
Homepage https://astroselling.com
Informations about the package jupiter-sdk
jupiter-sdk
PHP package para que los sistemas ERP se puedan integrar a la plataforma de gestión de tiendas online Astroselling - https://astroselling.com/
para instalarlo:
- composer require astroselling/jupiter-sdk
En la página de Astroselling, dentro del módulo “Mi cuenta” -https://nova.astroselling.com/admin/account- el usuario puede generar su propia API Key para acceder a estos servicios.
Por cualquier inconveniente, el equipo de soporte está siempre a las órdenes: [email protected]
Caso sea necesario hacer la integración directamente, usando otro lenguaje, esta es la documentación de las API´s:
Astroselling Jupiter - API
A continuación se podrán observar un conjunto de endpoints para poder integrar productos a Astroselling. En particular, se detallará cómo crear, actualizar y eliminar productos, obtener los canales asociados a un usuario y sus productos respectivos y visualizar el estado de la plataforma.
En la página de Astroselling, dentro del módulo "Mi cuenta" -https://nova.astroselling.com/admin/account- el usuario puede generar su propia API Key para acceder a estos servicios.
Por cualquier inconveniente, el equipo de soporte está siempre a las órdenes: [email protected]
Indice
- Autenticación
- Create Product
- Delete Product
- Get Channel Products
- Get Channel Products Info
- Get Channels
- Healthcheck
- Update Product
Authentication
Para consumir los endpoints se requiere autenticarse con un usuario de Astroselling. El token se puede obtener desde https://nova.astroselling.com, ingresando con el usuario correspondiente y luego ingresando a la sección "Mi Cuenta". Desde allí se podrá, además, generar un nuevo token, invalidando inmediatamente el token anterior.
Existen dos maneras de enviar el TOKEN para autenticar un request:
Autenticación por QueryString:
**Atención: este método es inseguro ya que el token es enviado en la URL.
En la URL del request, añadir el querystring
Ejemplo:
Autenticación por Bearer Token:
Agregar un header con el nombre "Authentication" y el valor "Bearer {{api_token}}". Ejemplo:
Ejemplo llamado CURL:
Ejemplo en PHP con cliente Guzzle:
1. Create Product
Este endpoint se utiliza para dar de alta un producto en Astroselling. En el body del POST se debe de mandar toda la información del producto.
- Esta información también pueden ser las variaciones.
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json |
Body:
2. Delete Product
Este endpoint se utiliza para eliminar un producto de un canal.
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json |
3. Get Channel Products
El endpoint en cuestión retorna todos los artículos relacionados a un canal en particular. En particular, veremos los siguientes datos:
- channel_id
- id_in_erp
- sku
- title
- price
- currency
- stock
- description
- extra_info
- variations
- images
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Accept | application/json |
Query params:
Key | Value | Description |
---|---|---|
limit | 20 | |
offset | 0 |
4. Get Channel Products Info
Retorna la información de un canal y producto en particular. Específicamente retorna los siguientes atributos
- channel_id
- id_in_erp
- sku
- title
- price
- currency
- stock
- description
- extra_info
- variations
- images
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Accept | application/json |
5. Get Channels
Entrega una lista de los Canales (con sus respectivos identificadores) que tiene el usuario. A partir de los IDs de la respuesta se podrán ejecutar los próximos endpoints. En particular, retorna el id del Canal, el nombre interno, el método de sincronización (el cual generalmente es "push") y el tipo de Canal.
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Accept | application/json |
6. Healthcheck
El endpoint en cuestión permite obtener el estado de la plataforma.
- Si la API está saludable, retorna un HTTP Code 200.
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Accept | application/json |
7. Update Product
Este endpoint se utiliza para actualizar la información de un artículo de un canal. Se debe pasar únicamente los atributos que se quieran actualizar. Luego de hacer el PUT, se recibirá como retorno toda la información del producto de Astroselling actualizado.
- El atributo imágenes debes ser un arreglo.
Endpoint:
Headers:
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Accept | application/json |
Body:
Available Variables:
Key | Value | Type |
---|---|---|
base_url | http://nova.astroselling.com/jupiter/v1 | |
api_token | XXXnBeVSIFFyldmxphoZTpYxfaMRm8xtUocYGpeiA4ftEKcXeP8aJif9AZZZ | |
channel_id | 9999 |
Back to top