Manteca

Introducción

Autenticación

Errores

Paginación

Webhooks

Configuración

Ejemplos

Recursos principales

Compañía

Contabilidad

Onboarding

Compliance

Usuarios

Balances

Bancos

Órdenes

Sintéticos

Precios

Dividendos

Estadísticas

Gestión de carteras

Flujos de API

Alta de usuario

Operación de dólar MEP

Health

Theneo Demo TechCrunch

API Broker

brokerage-as-a-service. Let your users buy and sell stocks and bonds with a single API integration

Docs - API Broker

Producción

Sandbox

<p class="slate-p " ></p><p class="slate-p " >Manteca está organizada alrededor de la interfaz <a href="https://en.wikipedia.org/wiki/REST" target="_self">REST</a>. Tiene URLs predecibles orientadas a recursos y usa códigos de respuesta HTTP estándar. Todos los valores de retorno son en formato JSON. </p><p class="slate-p " >Contamos con un sandbox para que puedas probar el API sin alterar los flujos productivos. Para acceder al mismo, tendrás que usar la URL correspondiente (junto con sus API keys).</p><p class="slate-p " >Por otro lado, para todo lo que es notificaciones hacia el lado del cliente, utilizamos webhooks. También contamos con un servicio de websockets para escuchar algunos eventos como los precios.</p><p class="slate-p " >El API utiliza el protocolo <a href="https://en.wikipedia.org/wiki/HTTPS" target="_self">HTTPS</a> para exponenr los endpoints. No soporta HTTP.</p><p class="slate-p " ></p><p class="slate-p " ></p>

Manteca está organizada alrededor de la interfaz 

. Tiene URLs predecibles orientadas a recursos y usa códigos de respuesta HTTP estándar. Todos los valores de retorno son en formato JSON. 

Contamos con un sandbox para que puedas probar el API sin alterar los flujos productivos. Para acceder al mismo, tendrás que usar la URL correspondiente (junto con sus API keys).

Por otro lado, para todo lo que es notificaciones hacia el lado del cliente, utilizamos webhooks. También contamos con un servicio de websockets para escuchar algunos eventos como los precios.

 para exponenr los endpoints. No soporta HTTP.

<p class="slate-p " ></p><p class="slate-p " >Manteca utiliza API keys para autenticar los requests. Las mismas son enviadas a través del header <code class="slate-code">md-api-key</code></p><p class="slate-p " >Las credenciales poseen privilegios completos por lo que es imprescindible que sean guardadas de manera segura. La interacción con Manteca debe ser siempre del lado del servidor, especialmente para los llamados autenticados.</p><p class="slate-p " >En ciertas implementaciones donde lo creemos conveniente, también realizamos IP whitelisting para aumentar la seguridad. </p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Manteca utiliza API keys para autenticar los requests. Las mismas son enviadas a través del header 

Las credenciales poseen privilegios completos por lo que es imprescindible que sean guardadas de manera segura. La interacción con Manteca debe ser siempre del lado del servidor, especialmente para los llamados autenticados.

En ciertas implementaciones donde lo creemos conveniente, también realizamos IP whitelisting para aumentar la seguridad. 

md-api-key

internalStatus

message

Ejemplo de respuesta de error

<p class="slate-p" placeholder="Type / for widgets">API Broker usa <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Status" target="_blank">respuestas HTTP</a> estándar para indicar resultados exitosos o fallidos. </p><p class="slate-p" placeholder="Type / for widgets">En general: </p><ul class="slate-ul"><li class="slate-li"><div style="position:relative">Códigos en el rango de <code class="slate-code">2xx</code> indican éxito.</div></li><li class="slate-li"><div style="position:relative">Códigos en el rango de <code class="slate-code">4xx</code> indican un error relacionado a la información provista (como parámetros omitidos o con un tipo inválido).</div></li><li class="slate-li"><div style="position:relative">Códigos en el rango de <code class="slate-code">5xx</code> indican un error inesperado en Manteca.</div></li></ul><p class="slate-p" placeholder="Type / for widgets">Más allá de los códigos, en caso de error, se podrá acceder a más detalle a partir de visualizar el body de la respuesta. Siempre se maneja un mismo formato que contiene por un lado un internalStatus que hace referencia a un código verbal de error y por otro, un message que es básicamente una descripción algo más detallada del error.</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"> </p><p class="slate-p" placeholder="Type / for widgets">
</p><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"><div class="slate-mention_input"></div></p><p class="slate-p" placeholder="Type / for widgets"></p>

 estándar para indicar resultados exitosos o fallidos. 

Más allá de los códigos, en caso de error, se podrá acceder a más detalle a partir de visualizar el body de la respuesta. Siempre se maneja un mismo formato que contiene por un lado un internalStatus que hace referencia a un código verbal de error y por otro, un message que es básicamente una descripción algo más detallada del error.

200 - OK

La creación de un recurso funcionó correctamente.

201 - Created

Todo funcionó correctamente y no hay response.

204 - No Content

El request tiene algún error. Por lo general, son conflictos con los parámetros enviados.

400 - Bad request

401 - Unauthorized

El API key no tiene suficientes permisos para realizar tal acción.

403 - Forbidden

404 - Not Found

La request genera un conflicto. Por ejemplo, por temas de duplicación de request.

409 - Conflict

La cantidad de requests enviados supera el límite impuesto.

429 - Too Many Requests

500 - Internal Server Error

<p class="slate-p" placeholder="Type / for widgets">Hay endpoints que devuelven arrays como response al pedido. En los casos en los que los datos pueden crecer dinámicamente, se devolverá la información de la paginación en el pedido y se aceptarán los siguientes parámetros para pedir los datos paginados.</p><h3 class="slate-h3">Parámetros</h3><ul class="slate-ul"><li class="slate-li"><div style="position:relative"><code class="slate-code">page</code>: Página actual, el default es 1.</div></li><li class="slate-li"><div style="position:relative"><code class="slate-code">limit</code>: La cantidad de elementos por página, el default es 10.</div></li></ul><p class="slate-p" placeholder="Type / for widgets"></p><p class="slate-p" placeholder="Type / for widgets"></p>

Hay endpoints que devuelven arrays como response al pedido. En los casos en los que los datos pueden crecer dinámicamente, se devolverá la información de la paginación en el pedido y se aceptarán los siguientes parámetros para pedir los datos paginados.

page

limit

<p class="slate-p " >Podés configurar los webhook endpoints a través del API para ser notificado por cada uno de los eventos que ocurran y te sean de interés, esto te permite recibir información en tiempo real sobre las operaciones que son relevantes para tu sistema.</p><p class="slate-p " >Entre ellos, encontrarás notificaciones relacionadas a cambios de estado de órdenes, sintéticos, depósitos y retiros.</p><p class="slate-p " >Es importante destacar que para validar la autenticidad de tales mensajes, los firmamos mediante el uso de HMAC con el secreto compartido. Tal firma la podrán obtener del header md-webhook-signature.
</p><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Configuración</h3><p class="slate-p slate-indent-0" style="0px">Necesitas configurar la company para recibir webhook a la URL definida, detallamos como realizar el proceso <a href="66b296ada8af550b2e34c2cb" target="">aquí</a></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Verificación HMAC</h3><p class="slate-p " >Cuando recibas el webhook necesitas realizar una verifiacion via el HMAC enviando en el header <strong class="slate-bold">md-webhook-signature</strong> con el secret configurado</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Procesamiento</h3><p class="slate-p slate-indent-0" style="0px">Si el proceso de verificación fue exitoso podes procesar el webhook ya que es validado, proporcionamos ejemplos de eventos <a href="6564bc5ae1bb0f042fa7fa47/66b295e5a8af550b2e349b61" target="">aquí</a></p><p class="slate-p " ></p></div></div></div><p class="slate-p " ></p>

Podés configurar los webhook endpoints a través del API para ser notificado por cada uno de los eventos que ocurran y te sean de interés, esto te permite recibir información en tiempo real sobre las operaciones que son relevantes para tu sistema.

Entre ellos, encontrarás notificaciones relacionadas a cambios de estado de órdenes, sintéticos, depósitos y retiros.

Es importante destacar que para validar la autenticidad de tales mensajes, los firmamos mediante el uso de HMAC con el secreto compartido. Tal firma la podrán obtener del header md-webhook-signature.


Sections