Arquitectura REST

Utilizamos una arquitectura REST, basada 100% en estándares de HTTP

Stateless

La API no maneja estados, toda la información necesaria es enviada por el cliente.

URLs

Cada recurso cuenta con su propia y única URL, siguiendo una jerarquía lógica. Por ejemplo:

• - URL de una sucursal: https://api-mx.enviopack.com/sucursales/:id
• - URL de un envío: https://api-mx.enviopack.com/envios/:id

Métodos HTTP

Todas las operaciones de realizan utilizando el método HTTP correcto para cada caso, por ejemplo:

• - GET: Para consultar y leer recursos
• - POST: Para crear recursos
• - PUT: Para editar recursos
• - DELETE: Para eliminar recursos.

URL base de la API

La URL base de la API, a partir de la cual puedes acceder a todos los recursos, es la siguiente:

https://api-mx.enviopack.com/

Datos en formato JSON

Los datos son enviados y recibidos en formato JSON (JavaScript Object Notation), que es un formato basado en texto, simple y fácilmente utilizable desde distintas plataformas. Ejemplo:

{
    "id": "1,
    "attribute": "value",
    "object": {
        "inner_id": 2,
        "inner_attribute": "inner_value"
    },
    "list": [
        "item 1",
        "item 2"
    ]
}

Seguridad

Para evitar que cualquiera pueda a la información de tu cuenta es muy importante que todas las llamadas a la API de Envíopack se realicen desde tu servidor. Nuestra API bloquea todo intento de utilización mediante un lenguaje cliente (ej. JavaScript), obligando así a su utilización mediante un lenguaje servidor (ej. PHP).

De esta manera nunca dejarás expuestas tus credenciales o tu Access Token.

API Rate Limit

Para asegurar la estabilidad y el uso correcto de nuestra plataforma se imponen límites al número de solicitudes de API que se pueden realizar.

El número máximo de solicitudes permitidas se basa en un máximo de 3000 request en un lapso de 5 minutos.

En caso de recibir un bloqueo recibirás un error code 429 y deberás esperar 5 minutos hasta que se te asigne cuota nuevamente (esto se realiza en forma automática)

Codificación UTF-8

Todas las solicitudes (requests) y respuestas (responses) utilizan codificación UTF-8.

Formato ISO-8601 para campos de fecha/hora

Todos los campos de fecha/hora utilizan el formato ISO-8601. Ejemplo:

2016-05-04 07:30:00