API para la gestión y administración de los saldos como sus movimientos.
URL´s
🛠️ Pruebas:
https://api.test.sw.com.mx 📄
🚀 Productivo:
https://api.sw.com.mx 📄
Consulta de Timbres
Revisa el detalle de los timbres disponibles de la cuenta asociada al token solicitado.
🔗 Endpoint
| Método | Ruta |
|---|---|
| GET | /management/v2/api/users/balance |
🔐 Autenticación y Headers
| Header | Value |
|---|---|
| Authorization | Bearer Token |
Ejemplo Request
curl --location 'https://api.test.sw.com.mx/management/v2/api/users/balance' --header 'Authorization: Bearer $token'
Ejemplo Response
{
"data": {
"idUserBalance": "98d97b7b-0000-0000-a090-24840a860a8c",
"idUser": "dec88317-0000-4000-9d23-9bb687444600",
"stampsBalance": 9284,
"stampsUsed": 549,
"stampsAssigned": 10000,
"isUnlimited": false,
"expirationDate": null
},
"meta": null,
"links": null,
"status": "success"
}
{
"message": "El usuario no existe",
"status": "error"
}
| Atributo | Tipo | Descripción |
|---|---|---|
| status | string | Indica el estado de la respuesta. Puede ser “success” o “error”. |
| message | String | Solo aparece en respuestas con error. Describe la causa del fallo. |
| data | Object/null | Contiene la información relacionada con el saldo del usuario y ultima transacción. |
Añadir Timbres
Servicio que permite agregar una cantidad de timbres a tus clientes.
🔗 Endpoint
| Método | Ruta |
|---|---|
| POST | /management/v2/api/dealers/users/{userId}/stamps |
🔐 Autenticación y Headers
| Header | Value |
|---|---|
| Authorization | Bearer Token |
| Content-Type | application/json |
📍 Parámetros Path
| Propiedad | Tipo | Uso | Descripción |
|---|---|---|---|
| userId | guid | Requerido | ID del usuario al que se le agregaran timbres. Se puede consultar este dato mediante la API de consulta usuarios. |
🧾 Parámetros JSON
| Propiedad | Tipo | Uso | Descripción |
|---|---|---|---|
| stamps | int | Requerido | Numero de timbres a abonar. |
| comment | string | Opcional | Comentario agregado al movimiento. |
Ejemplo Request
curl --location 'https://api.test.sw.com.mx/management/v2/api/dealers/users/d1defb8a-0000-0000-83f2-989458750cfa/stamps'
--header 'Authorization: bearer $token'
--header 'Content-Type: application/json'
--data '{
"stamps": 1,
"comment": "Abono de timbres"
}'
Ejemplo Response
{
"data": 72,//Total de timbres después del abono
"meta": null,
"links": null,
"status": "success"
}
{
"message": "El usuario no fue encontrado.",
"status": "error"
}
| Atributo | Tipo | Descripción |
|---|---|---|
| status | string | Indica el estado de la respuesta. Puede ser “success” o “error”. |
| message | String | Solo aparece en respuestas con error. Describe la causa del fallo. |
| data | String/null | Muestra la cantidad de timbres de la cuenta después del abono de timbres. |
Eliminar Timbres
Servicio que te permite remover una cantidad de timbres a tus clientes.
🔗 Endpoint
| Método | Ruta |
|---|---|
| DELETE | /management/v2/api/dealers/users/{userId}/stamps |
🔐 Autenticación y Headers
| Header | Value |
|---|---|
| Authorization | Bearer Token |
| Content-Type | application/json |
📍 Parámetros Path
| Propiedad | Tipo | Uso | Descripción |
|---|---|---|---|
| userId | guid | Requerido | ID del usuario al que se le retiraran timbres. Se puede consultar este dato mediante la API de consulta usuarios. |
🧾 Parámetros JSON
| Propiedad | Tipo | Uso | Descripción |
|---|---|---|---|
| stamps | int | Requerido | Cantidad de timbres a descontar |
| comment | string | Opcional | Comentario agregado al movimiento |
Ejemplo Request
curl --location --request DELETE 'https://api.test.sw.com.mx/management/v2/api/dealers/users/d1defb8a-0000-0000-83f2-989458750cfa/stamps'
--header 'Authorization: bearer $token'
--header 'Content-Type: application/json'
--data '{
"stamps": 1,
"comment": "Se elimina 1 timbre"
}'
Ejemplo Response
{
"data": 71,//Total de timbres despues de remover
"meta": null,
"links": null,
"status": "success"
}
Respuesta de error.
{
"message": "El usuario no fue encontrado.",
"status": "error"
}
Respuesta de error cuando el cliente no tiene suficiente saldo para remover esa cantidad de timbres.
{
"message": "El cliente no tiene suficiente saldo para remover esa cantidad de timbres.",
"status": "error"
}
| Atributo | Tipo | Descripción |
|---|---|---|
| status | string | Indica el estado de la respuesta. Puede ser “success” o “error”. |
| message | String | Solo aparece en respuestas con error. Describe la causa del fallo. |
| data | String/null | Muestra la cantidad de timbres de la cuenta después de remover los timbres. |
En SW® somos mejores para TI, es por ello que tu opinión es muy importante, por favor ayúdanos calificando este articulo y dejando tus comentarios.