View source for Metropolis Microservices/Tools/API Usage

<noinclude>
{{Metropolis Microservices/Head
|previous=https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/Tools/NVStreamer
|next=https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/Contact Us
|title=Performance and Footprint
|description=This page provides a general overview of the PTZ RidgeRun Service
}}
</noinclude>

Each service comes with [https://swagger.io/ swagger] API documentation. This documentation can be used to easily interact with the service.

Let's take as an example the [[Metropolis_Microservices/RidgeRun_Services/PTZ|PTZ]] service with this [http://ptz-open-ridgerun-microservices-2efaf0a4f1603b8261a38e081cca98a.pages.ridgerun.com/api.html API documentation].

The first thing to do is to identify the API call you want to do. Let's imagine we want to change the position so we need to use '''PUT /position'''.

 
[[File:Ptz-put-position.png|800px|thumb|center]]

If you expand the call, you will see something similar to this:

[[File:Ptz-put-position-expanded.png|800px|thumb|center]]

Now, if you click the '''Try it out''' button, you will see the following section:

[[File:Ptz-put-try-it-out.png|800px|thumb|center]]

At that point, you can edit the request body or arguments (if any). Then you need to click the '''Execute''' button. 

If the web browser used to see the API documentation is running in the same device running the server, this will be it, you just talked to the service. If it is running from a different device, then you will notice an error message:

[[File:Ptz-put-error.png|800px|thumb|center]]

If this is the case, you will also notice that a curl command is shown:

[[File:Ptz-put-curl.png|800px|thumb|center]]

Just replace the command IP address for the one of the server running the service and execute:

<syntaxhighlight lang="bash">
curl -X 'PUT' \
  'http://127.0.0.1:5010/position' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
  "pan": "45.0",
  "tilt": "45.0"
}'
</syntaxhighlight>

<noinclude>
{{Metropolis Microservices/Foot
|previous=https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/Tools/NVStreamer
|next=https://developer.ridgerun.com/wiki/index.php/Metropolis_Microservices/Contact Us
}}
</noinclude>