La APIs de Reviso son RESTful API, basadas en el protocolo HTTP y en el formato JSON.
Demostración de autenticación de REST API
Si quieres testar las APIs antes de registrar un contrato de desarrollador, puedes hacerlo con un contrato especial de demostración. Hay dos maneras de hacer esto.
1. A través de la cadena de consulta
Este primer modo es muy sencillo. Basta con añadir el siguiente texto ?demo=true a la solicitud de URL.
Solo se necesita esto ya que la primera llamada y las sucesivas a la API tendrán añadida esta cadena de consulta.
Todas las respuestas “401 no autorizadas” incluyen este enlace de demostración. Esto permite una fácil navegación de la API cuando se quiere averiguar qué está disponible.
Entra aquí para ver información adicional.
2. A través de conectores
La segunda forma es a través de una aplicación que te permite decir “hola mundo”. Esto imita el flujo de autenticación que se deberá utilizar cuando se crea la propia aplicación.
Solo tienes que especificar las cabeceras HTTP para los tokens X-AgreementGrantToken: demo y X-AppSecretToken: demo.
De esta manera es posible crear una aplicación y conectarse tal y como lo haría si tuvieses una integración real, pero sin la necesidad de registrarse.
Nota: cuando se utiliza la integración de demostración, solo podemos usar el método HTTP GET.
Lee más información aquí.
Otros
Enlace propio (Self link)
Todos los recursos y todas las colecciones tienen una propiedad “self” que contiene la dirección URL única que representa exactamente a ese recurso o esa colección.
A veces, la propiedad “self” de una colección puede contener también el diseño, el filtro o la clasificación aplicada.
Lee más información aquí.
Colecciones y recursos
La API REST de Reviso es una API basada en un documento de tipo JSON, el cual consiste en una serie de recursos y colecciones de recursos.
Las colecciones toman su nombre del tipo de recurso que se encuentra en la propia colección. Por ejemplo, una colección de clientes (customers) se llamará: https://rest.reviso.com/customers.
Cada recurso en la colección contendrá un enlace al mismo recurso, que estará compuesto por el enlace a la colección más la identificación del recurso. Así, el cliente número 20, por ejemplo, tendría el siguiente enlace: https://rest.reviso.com/customers/20.
Lee más información aquí.
Anotaciones sobre errores
Nota: esta característica es bastante nueva. Por ello, no todos los criterios de valoración han sido puestos en práctica.
Durante la creación o la modificación de datos a través de la REST API, será efectuada una validación de los datos proporcionados antes de realizarse cualquier operación de creación/modificación.
Si existen errores la operación no será aceptada y aparecerá el mensaje de error 404, el cual mostrará entre todos sus datos la información sobre los errores encontrados.
Lee más información aquí.
Errores
Lee más información aquí.
Control de versiones
Lee más información aquí.
Paginación
Lee más información aquí.
Filtros
Lee más información aquí.
Clasificación
Lee más información aquí.
Estado de códigos HTTP
Lee más información aquí.
Criterios de valoración (Endpoints)
Las REST API están en constante evolución, por lo que están divididas en estables y experimentales.
Recursos estables: son recursos ya publicados, confiables. Se pueden añadir a otras propiedades o puntos finales pero nunca va a cambiar su estructura o el nombre de una propiedad.
Recursos experimentales: son solo eso, recursos experimentales. Se decidió exponerlos públicamente a modo de poder tener una idea de que se está construyendo.
Puedes probar estos criterios de valoración experimentales, aunque se aconseja encarecidamente no depender de estos recursos para el despliegue de tus aplicaciones o integraciones.
Su firma está sujeta a modificaciones y la denominación de las propiedades puede cambiar también, sin previo aviso. Cuando los recursos experimentales son definitivos, se mueven al grupo de recursos estables, listos en producción.
Encuentra aquí una lista de criterios de valoración (endpoints) y más información.