Admin API

Esta API reúne acciones administrativas. Nunca debe ser llamada desde el client-side.

• Autenticación
• Obtener enlace de evaluación
• Crear pedido
• Actualizar pedido
• Obtener evaluaciones

Autenticación

Debes llamar a la API de Auth0, nuestro proveedor de autenticación, para que puedas utilizar los demás endpoints de nuestra API administrativa.

POST https://konfidency.us.auth0.com/oauth/token

Campos del cuerpo de la solicitud (JSON)

Parámetro	Descripción
audience	Fijo: https://reviews-api.konfidency.com.br
grant_type	Fijo: client_credentials
client_id	ID de cliente enviado por el equipo de integración.
client_secret	Token secreto enviado por el equipo de integración.

Ejemplo de cuerpo de la solicitud

{
  "audience": "https://reviews-api.konfidency.com.br",
  "grant_type": "client_credentials",
  "client_id": "eSRTjDtxTaprkd6Yb97DouqFORbTT1dV",
  "client_secret": "cSrP6TF1ktSAH1IV1p24Vztd9Lc4AoLA62f0KIPU1vkymSjd7a5QzpTy0Tqo51PZ"
}

Respuesta

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Campos

campo	descripción
access_token	Token de acceso generado
expires_in	Tiempo de validez del token
token_type	Tipo de token, siempre será Bearer

Enlace de evaluación

Permite obtener el enlace de evaluación para un pedido.

GET /{customer}/orders/{orderId}/ratelink

Parámetros de URL

Parámetro	Descripción
customer	Proporcionado por nuestro equipo de integración
orderId	Número del pedido en tu plataforma

Respuesta

{
  "link": "https://www.kfy.app/rate/konfidency/62b266a92bbbb599f720bb22/123456-1"
}

Campos

campo	descrição
link	URL única para la evaluación del pedido

Crear pedido

Integra un nuevo pedido en la plataforma Konfidency Reviews.

POST /{customer}/orders

Parámetros de URL

Parámetro	Descripción
customer	Proporcionado por nuestro equipo de integración

Parámetros del cuerpo de la solicitud

Parámetro	Descripción
orderId	Número del pedido en tu plataforma
created	Fecha de creación del pedido
userId	ID del usuario en la plataforma del cliente no utilizar datos sensibles
status	Status del pedido, created, authorized, shipped o delivered
estimatedDeliveryDate	Fecha de entrega prevista del pedido
name	Nombre del cliente
email	Correo electrónico del cliente - obligatorio para notificaciones por correo electrónico
phone	Teléfono móvil del cliente - obligatorio para notificaciones por SMS y WhatsApp
optOutEmail	Indica si el cliente optó por no recibir correos electrónicos (opt-out)
optOutSMS	Indica si el cliente optó por no recibir mensajes SMS (opt-out)
optOutWhatsApp	Indica si el cliente optó por no recibir mensajes a través de WhatsApp (opt-out)
items.sku	SKU del producto

Ejemplo de cuerpo de la solicitud

{
  "orderId": "P123456-1",
  "createdDate": "2022-06-01 12:34",
  "userId": "12345",
  "name": "João da Silva",
  "email": "[email protected]",
  "phone": "551191234-5678",
  "status": "created",
  "estimatedDeliveryDate": "2022-07-15",
  "optOutEmail": false,
  "optOutWhatsApp": false,
  "optOutSMS": true,
  "items": [
    {
      "sku": "01001"
    }
  ]
}

Respuesta

Esta API no genera un JSON de respuesta, un estado 200 significa que los datos se guardaron correctamente.

Actualizar pedido

Actualiza el estado del pedido en la plataforma Konfidency Reviews.

PUT /{customer}/orders/{orderId}

Parámetros de URL

Parámetro	Descripción
customer	Proporcionado por nuestro equipo de integración
orderId	Número del pedido en tu plataforma

Parámetros del cuerpo de la solicitud

Parâmetro	Descrição
created	Fecha de creación del pedido
status	Status del pedido, created, authorized, shipped o delivered
authorizedDate	Fecha de pago del pedido
deliveredDate	Fecha de entrega del pedido

Ejemplo de cuerpo de la solicitud

{
  "status": "authorized",
  "authorizedDate": "2022-06-01 12:34"
}

Respuesta

Esta API no genera un JSON de respuesta, un estado 200 significa que los datos se guardaron correctamente.

Obtener evaluaciones

Obtiene las evaluaciones según los criterios de búsqueda.

GET /{customer}/reviews/all

Parámetros de URL

Parámetro	Descripción
customer	Proporcionado por nuestro equipo de integración
sku	SKU del producto que deseas buscar
status	Status de las evaluaciones que se desean buscar (consulta la tabla a continuación)
order	Ordenación de los resultados (consulta la tabla a continuación)
skip	Cantidad de registros a omitir (paginación)

Status de las evaluaciones

Status	Descripción
	Omitir este campo o enviar una cadena vacía traerá evaluaciones en cualquier estado
published	Evaluaciones publicadas
removed	Evaluaciones rechazadas/eliminadas
filtered	Evaluaciones filtradas por el filtro de palabras prohibidas
pending	Evaluaciones en la cola de moderación

Ordenación de los resultados

La ordenación sigue el patrón campo,orden. El orden puede ser 1 para ascendente o -1 para descendente.

Campo	Descripción
created	Fecha de envío de la evaluación
sku	SKU del producto
rating	Calificación de la evaluación (de 1 a 5)
helpful	Las más marcadas como útiles
unhelpful	Las más marcadas como no útiles

Respuesta

{
  "results": [
    {
      "_id": "630adeb56a21590014e4e200",
      "helpful": 0,
      "unhelpful": 0,
      "verified": true,
      "moderationTags": [],
      "status": "published",
      "created": "2022-08-28T03:19:17.374Z",
      "pictures": [
        {
          "_id": "629f79d569ede80012ca7172",
          "url": "https://uploads.konfidency.com.br/a98cd120-abe9-436f-b4de-78e8a0b52071"
        }
      ],
      "customer": "konfidency",
      "userId": "a6c42ec0-ed92-4464-8dfc-fd7593472767",
      "name": "Dominic T",
      "sku": "307645",
      "text": "Producto perfecto para mis necesidades.",
      "recommended": true,
      "rating": 5,
      "source": "sdk",
      "__v": 1,
      "attributes": [
        {
          "_id": "61f7162480088014770d11af",
          "title": "Costo/beneficio",
          "type": "stars",
          "scaleMin": 0,
          "scaleMax": 5,
          "value": 5
        },
        {
          "_id": "627da5f10d1b0c410a99a1eb",
          "title": "Calidad",
          "type": "stars",
          "scaleMin": 0,
          "scaleMax": 5,
          "value": 5
        }
      ],
      "product": {
        "_id": "6284033fb0b7371985a42200",
        "customer": "konfidency",
        "sku": "307645",
        "name": "Bandeja travessa oval 33 cm x 23 cm",
        "categories": [
          "Cocina",
          "Cena"
        ],
        "url": "https://www.site.com.br/bandeja-oval-33-cm-x-23-cm",
        "image": "https://images.site.com.br/arquivos/ids/1857460-200-200/Bandeja-Oval-33-Cm-X-23-Cm.jpg?v=637020162237200000"
      }
    }
  ],
  "total": 30958
}

Campos

campo	descripción
results._id	ID único de la evaluación
results.sku	SKU del producto que deseas buscar
results.name	nombre del cliente que evaluó
results.rating	alificación otorgada por el cliente
results.text	texto de la evaluación del cliente
results.helpful	cantidad de personas que consideraron útil la evaluación
results.unhelpful	cantidad de personas que no consideraron útil la evaluación
results.verified	indica si el cliente es un comprador verificado
results.created	fecha de envío de la evaluación.
results.recommended	indica si el cliente calificó el producto positivamente
results.pictures	fotos enviadas con la evaluación
results.pictures._id	ID único de la foto
results.pictures.url	URL de la foto
total	total de evaluaciones obtenidas con los criterios de búsqueda