Getting ready

To start using the platform requires users to be created and appropriate accesses are given. These access privileges are set up in Access Manager component of Syvizo API Platform. An administrator can create users and set up the privileges to the users. Administrator is the first user created on the platform. The administrator can set up the rest of the users, roles and accesses. The Role required to create or modify APIs is a API designer. 

More details on managing users and accesses can be found at <link> Access Manager.

An API would typically have a set of paths or endpoint urls that identify specific data access or modifications. An endpoint can have one or more HTTP methods (sometimes referred as ‘HTTP verbs’) such as GET, POST, PUT, PATCH, DELETE, OPTIONS, HEAD and TRACE. The HTTP methods indicate the desired action to be performed on data.

GET

The GET method requests a representation of the specified resource. Requests using GET should only retrieve data.

POST

The POST method submits an entity to the specified resource, often causing a change in state or side effects on the server.

PUT

The PUT method replaces all current representations of the target resource with the request payload.

PATCH

The PATCH method applies partial modifications to a resource.

DELETE

The DELETE method deletes the specified resource.

OPTIONS

The OPTIONS method describes the communication options for the target resource.

HEAD

The HEAD method asks for a response identical to a GET request, but without the response body.

TRACE

The TRACE method performs a message loop-back test along the path to the target resource.