> For the complete documentation index, see [llms.txt](https://support.mindbox.app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://support.mindbox.app/configuracion-inicial/api.md).

# API

En MindBox, para establecer la conectividad a través de nuestra API, es necesario tener su propia aplicación o servicio web que se comunique con nuestra plataforma. Pueden realizar esta comunicación utilizando un token de acceso o a través de OAuth. 

Para obtener las claves de acceso, simplemente pueden generarlas desde la interfaz de la plataforma MindBox. Esta integración les permitirá interactuar de manera segura y eficiente con nuestros servicios.

{% hint style="info" %}
**Note**: Cabe mencionar que tu institución debe contar con un equipo de desarrollo propio el cuál va a utilizar la API.
{% endhint %}

Si necesitan apoyo adicional no dudes en contactar a nuestro equipo de soporte <mark style="color:purple;">**<support@mindbox.app>**</mark> que con gusto te brindará la asistencia necesaria.

### Cliente

Un cliente es una aplicación, servicio o software que consume o utiliza los servicios proporcionados por una API. En seguida te mostraremos cómo puedes crear agregar un cliente desde MindBox y como borrarlo si lo necesitas.

#### Nuevo cliente

En el menú de <mark style="color:purple;">**`Escuela > Configuración > API`**</mark> se mostrarán las opciones de crear un Nuevo Cliente.

<figure><img src="/files/TmQ1rEcq4gy5MAxfbBhT" alt=""><figcaption><p>Creación de nuevo cliente API</p></figcaption></figure>

Para dar de alta un nuevo cliente daremos clic en el botón <mark style="color:purple;">**Nuevo Cliente**</mark><mark style="color:purple;">,</mark> esto nos arrojará un pequeño formulario en el cual debemos completar los campos  de Nombre y URL de autorización de tu aplicación. Posteriormente seleccionaremos la casilla <mark style="color:purple;">**confidencial**</mark> que permitirá que el cliente se autentique de manera segura, por último damos clic en el botón <mark style="color:purple;">**Crear**</mark>.

<figure><img src="/files/kf5tYmn4TyGBzB1EftXl" alt="" width="375"><figcaption><p>Registro de nuevo cliente API.</p></figcaption></figure>

Se mostrará en el listado el nuevo cliente creado con su respectiva llave de acceso.

<figure><img src="/files/yninoowei4Y6Iy0uwyqj" alt=""><figcaption><p>Cliente API creado correctamente</p></figcaption></figure>

#### Editar Cliente

Podemos editar nuestro cliente creado dando clic en el botón <mark style="color:purple;">**Editar**</mark>, nos mostrará un pequeño formulario con el que  podemos editar el Nombre del cliente y la URL de redirección de nuestra aplicación una vez editados los datos daremos clic en <mark style="color:purple;">**Guardar**</mark>.

<figure><img src="/files/Ju7shFN0I27amWCWlrsf" alt="" width="375"><figcaption><p>Formulario de edición de cliente de API</p></figcaption></figure>

### Token

Un token es una cadena de caracteres única y segura que se utiliza para autenticar y autorizar las solicitudes realizadas a una API. En seguida te mostramos cómo generar un token en MindBox y como borrarlo.

#### Nuevo token

En el menú de <mark style="color:purple;">**`Escuela > Configuración > API`**</mark> se mostrarán las opciones de crear un Nuevo Token daremos clic en el botón <mark style="color:purple;">**Crear nuevo token**</mark>.

<figure><img src="/files/lKGmTkgcoxOBNgRNEpZT" alt=""><figcaption><p>Creación de nuevo token</p></figcaption></figure>

Nos aparecerá una ventana donde debemos ingresar el nombre del token, posteriormente daremos clic en el botón <mark style="color:purple;">**Crear**</mark>.

<figure><img src="/files/5a5zesF7L3ydzaFZJ5JC" alt="" width="375"><figcaption><p>Generaciòn de nuevo token.</p></figcaption></figure>

Una vez realizado lo anterior nos mostrará una nueva ventana con el Token de acceso personal generado. Ahora puede usar este token para realizar solicitudes de API.

{% hint style="danger" %} <mark style="color:red;">**Importante:**</mark> esta será la única vez que se mostrará el token, así que debe asegúrese almacernarlo y no perderlo.
{% endhint %}

<figure><img src="/files/0pO5tA82msuo3vkXutne" alt="" width="375"><figcaption><p>Token.</p></figcaption></figure>

Podremos ver que quedó registrado en de <mark style="color:purple;">**`Escuela > Configuración > API`**</mark>.

<figure><img src="/files/r6Y3MuZCSJ5lCujSnlDf" alt=""><figcaption><p>Nuevo token generado.</p></figcaption></figure>

#### Eliminar token

Podemos eliminar nuestro token y generar uno nuevo posteriormente, para ello solo daremos clic en el botón <mark style="color:purple;">**Eliminar**</mark>.&#x20;

{% hint style="danger" %}
Una vez eliminado el token no se podrá recuperar. &#x20;
{% endhint %}