Saltar al contenido

API Reference (1.0)

El API de ZRU utiliza métodos HTTP y una estructura RESTful de endpoint.

  • La autenticación del API se realiza vía Header Authorization.
  • Todas las peticiones se deben realizar en formato JSON, y las respuestas del API son en dicho formato.
Descargar descripción de OpenAPI
Resumen
Idiomas
Servidores
v1

https://api.zrupay.com/v1/

Operaciones
Operaciones
Operaciones
Operaciones
Operaciones

Solicitud

Devuelve todos los productos creados en el entorno.

Seguridad
AppKeys
curl -i -X GET \
  https://api.zrupay.com/v1/product/ \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respuestas

OK

Cuerpoapplication/json
countnumber

Cantidad de elementos

items_per_pagenumber

Cantidad de elementos por página

nextstring or null

URL a próxima página

previousstring or null

URL a página anterior

resultsArray of objects(product.v1)
Respuesta
application/json
{ "count": 0, "items_per_page": 0, "next": "string", "previous": "string", "results": [ {} ] }

Solicitud

Crea un producto en el entorno.

Seguridad
AppKeys
Cuerpoapplication/json
product_idstring

Identificador externo

namestringrequerido

Nombre

pricenumber(float)requerido

Precio

descriptionstring

Descripción

curl -i -X POST \
  https://api.zrupay.com/v1/product/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "NAME",
    "price": 15,
    "product_id": "MERCHANT_PRODUCT_ID",
    "description": "DESCRIPTION",
    "extra": {
      "MERCHANT_KEY": "MERCHANT_VALUE"
    }
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

product_idstring

Identificador externo

namestringrequerido

Nombre

pricenumber(float)requerido

Precio

descriptionstring

Descripción

Respuesta
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "product_id": "string", "name": "string", "price": 0.1, "description": "string" }

Solicitud

Devuelve el producto solicitado.

Seguridad
AppKeys
Ruta
product-idstring(uuid)requerido

Identificador del producto que se desea solicitar

curl -i -X GET \
  'https://api.zrupay.com/v1/product/{product-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

product_idstring

Identificador externo

namestringrequerido

Nombre

pricenumber(float)requerido

Precio

descriptionstring

Descripción

Respuesta
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "product_id": "string", "name": "string", "price": 0.1, "description": "string" }

Solicitud

Edita el producto solicitado.

Seguridad
AppKeys
Ruta
product-idstring(uuid)requerido

Identificador del producto que se desea solicitar

Cuerpoapplication/json
product_idstring

Identificador externo

namestring

Nombre

pricenumber(float)

Precio

descriptionstring

Descripción

curl -i -X PATCH \
  'https://api.zrupay.com/v1/product/{product-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "price": 18
  }'

Respuestas

OK

Cuerpoapplication/json
idstring(uuid)

Identificador único

product_idstring

Identificador externo

namestringrequerido

Nombre

pricenumber(float)requerido

Precio

descriptionstring

Descripción

Respuesta
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "product_id": "string", "name": "string", "price": 0.1, "description": "string" }

Solicitud

Elimina el producto solicitado.

Seguridad
AppKeys
Ruta
product-idstring(uuid)requerido

Identificador del producto que se desea solicitar

curl -i -X DELETE \
  'https://api.zrupay.com/v1/product/{product-id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Respuestas

OK

Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones