Deyel API Rest
Deyel API Rest permite a desarrolladores y aplicaciones externas interactuar programáticamente con Deyel de manera sencilla, logrando una integración rápida con bajo costo de codificación.
El diseño está modelado como una jerarquía en la que cada nodo es un recurso simple o un recurso de colección. Por convención, al primero se lo llama “recurso” y al segundo se lo llama “colección”.
Los recursos se conocen como los sustantivos de la API.
Una colección contiene una lista de recursos del mismo tipo.
Ejemplo: La colección usuarios contiene una lista de usuarios donde cada uno de ellos es un recurso.
De acuerdo con la arquitectura REST estos recursos pueden utilizarse con una pequeña cantidad de métodos.
Los métodos se conocen como los verbos de la API.
Con el protocolo HTTP, los nombres de los recursos se mapean de forma natural a las URL, mientras que los métodos lo hacen a través del protocolo HTTP:
Los ejemplos que son explicados en cada uno de los métodos que se encuentran implementados sobre un proyecto en Postman y la colección se puede abrir desde aquí.
Para utilizar los endpoints incluídos en la colección, es necesario reemplazar en las variables de la misma, el valor “miambiente” con el correspondiente al ambiente a utilizar.
Seguridad
La seguridad de Deyel API Rest está implementada mediante el estándar OAuth 2.0, que permite acceder a los recursos provistos, mediante un único token de acceso de tipo Bearer.
Para comenzar a utilizar Deyel API Rest es necesario en primer lugar obtener el token de acceso, el cual es utilizado en los métodos que acceden e interactúan con los recursos.
