[NP] Implementación de la API de NetBox.

Resumen

En este artículo se habla como utilizar la API de la aplicación NetBox, la cual se utiliza para poder conectarse a la aplicación por medio del protocolo HTTP o HTTPS con los métodos POST y  GET en el artículo explica como pueden ser utilizados en un ambiente de C#.

Detalle

Unos de los primeros pasos que hay que hacer para poder empezar a utilizar la API es obtener la API que se acomode a nuestras necesidades, eso lo encontraremos en la documentación, la cual puedes obtener en el siguiente link -> https://demo.netbox.dev/api/docs/ con esto comenzaremos en este caso se utilizara la API de regions.

La manera la cual se utilizara esta informacion es del siguiente manera.

1. Primero se pone la IP de nuestro Netbox en tal caso para practicidad se utilizara “localhost” el localhost lo que hace es poner la ip del computador o host en cuestion, así facilitará muchas cosas por ahora, en caso de que haya una IP diferente lo pondrás en vez de “localhost” y quedara de la siguiente manera.

https://localhost/api/regions/

2. Ahora que se tiene la API a utilizar se empezara a hacer lo necesario, que es determinar los Header y el body de la peticion, los Header o cabeceras son la cabeza de la peticion, donde ira todo lo que necesita saber el protocolo HTTP para poder funcionar, como el metodo que utilizaremos, el link de la API, etc…

Esto se puede conseguir muy fácil viéndolo con un generador de request como REQBIN, pero se necesitara algo mas algo más para poder hacer este header o cabecera y eso es el token de seguridad, el token de seguridad se asegurara que sea un adminstrador que este haciendo la petición, para obtener este token se debe ir a la página de NetBox y seguir los siguientes pasos.

Este token solo se mostrará una vez, entonces procura no perderlo.

3. Ahora empezaremos a hacer la petición, en este caso se utilizara Curl, acá se muestra un ejemplo de cómo se vería una petición completa con sus respectivos headers y bodys.

Acá se ve una petición para consola, acá se ve el método en la primera parte, la ip la cual queremos trabajar, la API la cual vamos a ir, la -H la cual dice cual será el header y la autorización la cual se necesita, un código en c# para hacer una petición es el siguiente:

Ese es todo el procedimiento para hacer un método get, ahora se mostrara como hacer un método POST, el método POST se utiliza para poder crear objetos, pero para esto se necesitara más cosas para poder hacer el mismo, más específicamente un body, el body o cuerpo deberá traer la información la cual traerá el objeto a crear, en este caso una region, tomando eso en cuenta se puede proceder, primero se les mostrara un ejemplo con en curl o consola:

Esta información se ingresara en el código de c# también, un claro ejemplo del mismo es el siguiente:

En el mismo podemos ver que el method cambia a POST y también se agrego algo llamado data, el cual es por el medio que se envia la información la cual se necesita.

Con esto se concluye el Articulo sobre cómo utilizar la API de NetBox, la gran parte de este articulo ayudara a producir sus proyectos a la hora de la produccion, una recomendación dada por el escritor del artículo es la utilización de alguna página-extensión-programa que haga peticiones de todo tipo para que el que usa la API pueda hacer pruebas con la misma, el recomendado por el escritor es ReqBin HTTP API Client, el cual es un extensión de Google.