Overview

Open API de IDPOS, versión v1.

API pública de IDPOS (1.0.0)

La Open API de IDPOS permite consultar y registrar información de una tienda desde un sistema externo: tiendas, categorías y productos, ventas, turnos de caja cerrados, órdenes, cobros, mesas, clientes, anticipos y stock.

Todas las operaciones requieren las cabeceras I-Open-Api-Key e I-Open-Api-Token, que IDBI entrega al integrador. IDBI emite cada token para una tienda o para una organización. La URL base la proporciona IDBI.

Las respuestas de error tienen tres formatos distintos según el origen del error. El detalle figura en la página Introducción de la sección Open API del portal y en cada operación.

• OpenAPI version: 3.1.0

Authentication

OpenApiKey

Identificador del token de acceso (clave pública). IDBI lo entrega junto con el token. Debe enviarse siempre junto con I-Open-Api-Token. IDBI emite cada token para una tienda, que solo ve esa tienda, o para una organización, que ve todas las tiendas de la organización.

Security scheme type: apiKey

Header parameter name: I-Open-Api-Key

OpenApiToken

Valor secreto del token de acceso. IDBI lo entrega al integrador; no existe una operación de la API para generarlo. Tiene fecha de vencimiento y puede deshabilitarse. Debe enviarse siempre junto con I-Open-Api-Key. Un token de tienda o de organización solo accede a las tiendas que le corresponden. En las operaciones de /stores/{storeKey}/*, /orders/{orderKey}/* y /tables/{tableKey}/*, una tienda, una orden o una mesa de otra tienda, o que no existe, responde 403. Un anticipo que no pertenece a la tienda indicada responde 404.

Cómo proteger el token:

• Conserve I-Open-Api-Token solo en su servidor.
• No lo use en un navegador, en una aplicación móvil ni en una URL.
• Manténgalo fuera de los registros (logs) de su sistema.
• Si se filtra, avise de inmediato a IDBI.

Security scheme type: apiKey

Header parameter name: I-Open-Api-Token