Introducción
Manteca está organizada alrededor de la interfaz REST. 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.
El API utiliza el protocolo HTTPS para exponenr los endpoints. No soporta HTTP.
What made this section unhelpful for you?
Base URL
Producción:
https://api.manteca.dev/cambio
Sandbox:
https://sandbox.manteca.dev/cambio
What made this section unhelpful for you?
Autenticación
Manteca utiliza API keys para autenticar los requests. Las mismas son enviadas a través del header md-api-key
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.
What made this section unhelpful for you?
What made this section unhelpful for you?
Errores
API Cambio usa respuestas HTTP estándar para indicar resultados exitosos o fallidos.
En general:
- Códigos en el rango de
2xxindican éxito. - Códigos en el rango de
4xxindican un error relacionado a la información provista (como parámetros omitidos o con un tipo inválido). - Códigos en el rango de
5xxindican un error inesperado en Manteca.
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.
Ejemplo de respuesta de error
Código verbal de error
Descripción del error
What made this section unhelpful for you?
Status Codes
200
Todo funcionó correctamente.
201
La creación de un recurso funcionó correctamente.
204
Todo funcionó correctamente y no hay response.
400
El request tiene algún error. Por lo general, son conflictos con los parámetros enviados.
401
Falta enviar el API key.
403
El API key no tiene suficientes permisos para realizar tal acción.
404
No existe el recurso referenciado.
409
La request genera un conflicto. Por ejemplo, por temas de duplicación de request.
429
La cantidad de requests enviados supera el límite impuesto.
500
Algo funcionó mal de nuestro lado.
What made this section unhelpful for you?
Paginación
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.
Parámetros
page: Página actual, el default es 1.limit: La cantidad de elementos por página, el default es 10.
Header Parameters
Query Parameters
La página actual
La cantidad de elementos en cada página
What made this section unhelpful for you?
What made this section unhelpful for you?
Webhooks
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. Entre ellos, encontrarás notificaciones relacionadas a cambios de estado de órdenes, depósitos y retiros.
What made this section unhelpful for you?
Recursos principales
Base URL
Producción:
https://api.manteca.dev/cambio
Sandbox:
https://sandbox.manteca.dev/cambio