Postman es de las aplicaciones más usadas para crear colecciones de llamadas a API y hacer peticiones fácilmente.

1. Importar colección

  1. Descarga la versión de Postman para su sistema operativo desde la página de descargas
  2. Importa la definición de la API
    1. Presiona Ctrl+O o ve al menú: File > Import
    2. Seleccione la pestaña Link
    3. Introduce la siguiente URL: https://docs.librebor.me/swagger/librebor-openapi.yaml
    4. Haz click en Continue

2. Configurar credenciales

Para configurar sus credenciales sigue los pasos a continuación:

  1. Click derecho sobre la colección "LibreBOR API" y Edit
  2. Seleccione la pestaña Authorization
  3. En el campo "Type" seleccione "Basic Auth"
  4. Rellene los campos Username y Password
  5. Click en el botón Update

3. Tu primera petición

3.0. Comprueba la pestaña Authorization

  1. Desplieza la colección "Librebor API"
  2. Asegúrate siempre de que la pestaña en la Authorization en el campo "Type" está seleccionado "Inherit auth from parent".

3.1. Búsqueda de empresa

  1. Elija la acción "Search for a company" dentro de la carpeta "company"
  2. Seleccione la pestaña "Params" si no está ya seleccionada
  3. En el campo VALUE del parámetro "query" escriba "ABOGADOS"
  4. Presionar el botón Send

Si todo ha ido bien habrás obtenido el listado de empresas que contienen la palabra clave introducida en el punto 3. Para la siguiente sección, elige el campo slug de algún resultado.

Nota

Un slug es una cadena de texto separada con guiones que identifica de manera única a una empresa o un cargo directivo y se usa para realizar otras peticiones en la API.

3.2. Información de empresa

Para obtener la información de una empresa podemos hacerlo por Slug y por NIF. En este caso lo haremos con el Slug escogido en la sección anterior.

  1. Elija la acción "Get company information by Slug" dentro de la carpeta "company" > "by-slug/{slug}"
  2. Seleccione la pestaña "Params" si no está ya seleccionada
  3. En el campo VALUE del parámetro "slug" escriba el slug de una sociedad (por ejemplo: "1254-abogados")
  4. Presionar el botón Send

Si todo ha ido bien habrás obtenido los datos mercantiles de la sociedad 1254 ABOGADOS SLP.

Has llegado al final de este tutorial ¡Enhorabuena!