Tu programa de gift cards

GET/giftcards/programaProbar

ServidorURL base

API key x-api-keyRecordar la clave en este navegador (localStorage, no sale de aquí)

La llamada la hace tu navegador, contra el servidor que elijas arriba. Si la documentación no está servida desde el mismo origen que la API, el navegador puede bloquear la respuesta por CORS: en ese caso abre estas páginas desde la propia API (/docs) o usa el curl de arriba.

GET

/giftcards/programa

const url = 'http://localhost:3000/v1/giftcards/programa';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/v1/giftcards/programa \
  --header 'x-api-key: <x-api-key>'

Scope giftcards:read. Tu kit de marca, si tiene logo, las tiendas que elegiste y su version. Si todavía no existe, lo crea vacío.

Authorizations

ApiKeyAuth

Responses

200

El programa

application/json

object

estado

string

Allowed values: activo suspendido

kit

object

nombre

required

string

<= 60 characters

colores

object

primario

string

/^#[0-9A-Fa-f]{6}$/

acento

string

/^#[0-9A-Fa-f]{6}$/

fondo

string

/^#[0-9A-Fa-f]{6}$/

superficie

string

/^#[0-9A-Fa-f]{6}$/

texto

string

/^#[0-9A-Fa-f]{6}$/

texto_secundario

string

/^#[0-9A-Fa-f]{6}$/

radio

integer

<= 32

textos

Hasta 60 caracteres. {marca} se cambia por el nombre de la tienda.

object

titulo

string

<= 60 characters

boton_pagar

string

<= 60 characters

boton_secundario

string

<= 60 characters

regalo_para

string

<= 60 characters

soporte

object

whatsapp

Código de país y sólo dígitos

string

/^\d{8,15}$/

email

string format: email

url

Https://

string

pie_legal

string

<= 240 characters

tieneLogo

boolean

marcas

Las que elegiste; null = todas las habilitadas

Array<string>

nullable

marcasPermitidas

Las que te habilitamos; null = todas

Array<string>

nullable

marcasEfectivas

Las que puedes emitir hoy

Array<string>

nullable

version

Sube con cada cambio

integer

Example

{
  "estado": "activo",
  "kit": {
    "nombre": "Cacao Pay"
  }
}