Documentación

Consideraciones de diseño

Te mostramos las características más importantes de la arquitectura de nuestra API.

Indice

Arquitectura REST URL base de la API Datos en formato JSON Soporte Cross Domain (CORS) Codificación UTF-8 Formato de fecha y hora ISO-8601

Arquitectura REST

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

URL base de la API

La URL base de la API, a partir de la cual puedes acceder a todos los recursos, se mantiene constante para todos los servicios:

https://api.mercadoshops.com/v1/

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"
    ]    
}

Soporte Cross Domain (CORS)

Nuestra API soporta CORS (Cross-Origin Resource Sharing) para permitir su utilización desde cualquier dominio (origen) mediante la utilización del header:

Access-Control-Allow-Origin: *

Codificación UTF-8

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

Formato de fecha y hora ISO-8601

Todos los campos de fecha/hora utilizan la norma ISO-8601.

Ejemplo: 2014-04-24T16:37:22.032-04:00

< Conceptos básicosAutenticación >