Conceptos básicos
Última actualización

API

El API Rest de ZRU puede ser utilizado en sitios webs, aplicaciones móviles, softwares, etc.

Siempre que se utilice el API con una aplicación en Prueba no conllevará ningún gasto.

Para una mejor comprensión de la Referncia del API es indispensable entender algunos conceptos básicos que explicamos en esta sección.

URLs

El API de ZRU se encuentra alojada en: https://api.zrupay.com/v1/.

Para acceder a los recursos que se explican en la Referencia del API siempre se utlizará la siguiente estructura, mostrándola de manera relativa a https://api.zrupay.com/v1/:

  • Obtener lista de elementos: GET /<recurso>/

  • Obtener un elemento: GET /<recurso>/<identificador>/

  • Crear un elemento: POST /<recurso>/

  • Editar un elemento: PATCH /<recurso>/<identificador>/

  • Eliminar un elemento: DELETE /<recurso>/<identificador>/

  • Realizar una acción sobre un elemento: POST /<recurso>/<identificador>/<accion>/

Autenticación

Todas las peticiones que se realicen al API deben incluir un header Authorization con las credenciales del entorno que se está utilizando. El contenido del header Authorization tiene el siguiente formato: AppKeys <key>:<secret_key>

Al crear un entorno, se pueden obtener las credenciales de API en el Resumen del entorno. Estás credenciales deben permanecer en secreto, evite ponerlas en sitios como GitHub, código a nivel del cliente, y otros, principalmente el Código secreto.

Supongamos que las credenciales son las siguientes:

  • Código: at8844d39340

  • Código secreto: 8a78931t094c47819d85gf457fayc9d4

El header Authorization debe ser entonces: AppKeys aa8834d69280:8a78931g094c44519d83df457fayc9d4

Paginación

Algunas peticiones devuelven listas con varios elementos. En estos casos se utiliza paginación devolviendo 20 elementos por página.

Estás peticiones pueden recibir el parámetro page que devuelve la página solicitada.

La respuesta tendría el siguiente formato:

{
  "count": 50,
  "items_per_page": 20,
  "next": "<enlace a página siguiente>",
  "previous": "<enlace a página anterior>",
  "results": [...]
}

Recursos

Los recursos son los elementos que se pueden crear a través del API u obtener. Cada uno de estos elementos, ya sea al crearlos, editarlos o eliminarlos, siempre podrán ser verificados a través del Panel. En la [Referencia del API] son detallados.

 
Página siguiente