Deyel Rest API
Deyel Rest API allows developers and external applications to programmatically interact with Deyel in a simple way, achieving fast integration at low coding cost.
The layout is modeled as a hierarchy where each node is either a single resource or a collection resource. By convention, the former is called "resource" and the latter is called "collection".
Resources are known as API nouns.
A collection contains a list of resources of the same type.
Example: The users collection contains a list of users where each user is a resource.
According to the REST architecture these resources can be used with a small number of methods.
Methods are known as API verbs.
With the HTTP protocol, resource names map naturally to URLs, while methods map via the HTTP protocol:
The examples that are explained in each of the methods that are implemented on a project in Postman and the collection can be opened from here.
To use the endpoints included in the collection, it is necessary to replace the value "myenvironment" in the variables of the collection with the value corresponding to the environment to be used.
Security
The Rest API security of Deyel is implemented using the standard OAuth 2.0, which allows access to the provided resources, using a single Bearer type access token.
To start using Deyel Rest API, it is first necessary to obtain the access token, which is used in methods that access and interact with resources.
