Estructura de ApiMp

Métodos, URL, autenticación, encabezados, cuerpos, estados, paginación y límite de solicitudes de ApiMp.

Métodos

ApiMp sigue el estándar REST:

POST: creación de registros.
PUT: actualización de registros.
GET: consulta y listado.

URL

Host de todas las solicitudes:

https://api.demander.com.br

Ejemplos de endpoint:

api-mp/v1/clientes (GET y POST)
api-mp/v1/clientes/{id} (PUT)

Autenticación

La clave se envía en el encabezado CompanyToken.

La configuración se encuentra en Demander Web, en Configuración de ApiMp.

Encabezados de solicitud

Envío: obligatorio indicar CompanyToken y Content-Type: application/json.
Respuesta: depende del método.
- GET: Content-Type y encabezados de paginación.
- POST y PUT: tipo JSON, ID del registro y URL para consultarlo.

Cuerpos de solicitud

Envío: validado en POST y PUT. Los campos por método y tabla se encuentran en el artículo de campos.
Respuesta: también varía según el método y la tabla; la lista completa se encuentra en el mismo artículo.

Estados de respuesta

200: éxito.
201: creación completada.
403: empresa inactiva.
412: error en el cuerpo de la solicitud.
422: el registro no existe.
429: demasiadas solicitudes en poco tiempo.

Paginación

Válido solo en GET. El control se incluye en tres valores en el encabezado de respuesta:

Límite de registros: indica si hubo paginación.
Cantidad total de registros: cuántos registros se devolvieron en la página (máximo 150).
Solicitudes adicionales: cuántas páginas quedan con los parámetros utilizados.

Control de rendimiento

El límite se aplica a todos los métodos mediante la clave CompanyToken.

Cada empresa tiene un tope de solicitudes. Al superarlo, la API responde con HTTP 429:

{
  "tempo_ate_permitir_novamente": 120,
  "limite_de_requisicoes": 100
}

Si el ERP continúa realizando solicitudes después del 429, la integración puede bloquearse temporalmente:

{
  "mensagem": "Integração bloqueada por desrespeitar as políticas de throttling, entre em contato com o suporte.",
  "tempo_ate_permitir_novamente": 9999999,
  "limite_de_requisicoes": 0
}