Arquitectura REST

Utilizamos una arquitectura REST, basada al 100% en los 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.enviopack.com/sucursales/:id
• - URL de un envío: https://api.enviopack.com/envios/:id

Métodos HTTP

Todas las operaciones se 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.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 cualquier persona pueda acceder 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 cualquier intento de acceso mediante un lenguaje cliente (por ejemplo, JavaScript), obligando así a utilizar un lenguaje de servidor (por ejemplo, PHP).

De esta manera, nunca expondrás tus credenciales ni tu Access Token.

Codificación UTF-8

Todas las solicitudes (requests) y respuestas (responses) utilizan la 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