From f66808944dc3643f2a4e642bfe3e18c58a7319f2 Mon Sep 17 00:00:00 2001 From: Adson Rodrigues Date: Mon, 6 Jul 2026 11:19:02 -0300 Subject: [PATCH] =?UTF-8?q?docs:=20remove=20p=C3=A1gina=20de=20cole=C3=A7?= =?UTF-8?q?=C3=B5es=20Postman=20(cole=C3=A7=C3=A3o=20n=C3=A3o=20existe)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A coleção distribuída sob demanda nunca foi criada — remove a página nas 3 línguas e as entradas de navegação. O openapi.json continua disponível para importação em Postman/Insomnia/Bruno. Co-Authored-By: Claude Fable 5 --- docs.json | 9 ++--- en/guides/postman-collections.mdx | 53 ---------------------------- es/guides/postman-collections.mdx | 53 ---------------------------- pt-br/guides/postman-collections.mdx | 53 ---------------------------- 4 files changed, 3 insertions(+), 165 deletions(-) delete mode 100644 en/guides/postman-collections.mdx delete mode 100644 es/guides/postman-collections.mdx delete mode 100644 pt-br/guides/postman-collections.mdx diff --git a/docs.json b/docs.json index 2ccc960..52d14b5 100644 --- a/docs.json +++ b/docs.json @@ -46,8 +46,7 @@ "es/guides/authentication", "es/guides/balance", "es/guides/spei-cash-in", - "es/guides/spei-cash-out", - "es/guides/postman-collections" + "es/guides/spei-cash-out" ] }, { @@ -109,8 +108,7 @@ "en/guides/authentication", "en/guides/balance", "en/guides/spei-cash-in", - "en/guides/spei-cash-out", - "en/guides/postman-collections" + "en/guides/spei-cash-out" ] }, { @@ -173,8 +171,7 @@ "pt-br/guides/authentication", "pt-br/guides/balance", "pt-br/guides/spei-cash-in", - "pt-br/guides/spei-cash-out", - "pt-br/guides/postman-collections" + "pt-br/guides/spei-cash-out" ] }, { diff --git a/en/guides/postman-collections.mdx b/en/guides/postman-collections.mdx deleted file mode 100644 index 17ff4f3..0000000 --- a/en/guides/postman-collections.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: 'Postman Collections' -description: 'Import the official Postman collection to test the NTX Pay API locally.' -mode: 'wide' ---- - -## How to Get the Collection - -The official Postman collection with all public NTX Pay Mexico endpoints is distributed on demand. Request the `.json` file (Postman v2.1) by email at `suporte@ntxpay.com`. - -## Import into Postman - -1. Open Postman -2. **File → Import** -3. Select the `.json` file you received -4. Also import the provided environment and select **Sandbox** to start testing - -## Configure Environment Variables - -The environment expects 3 variables: - -| Variable | Description | Example | -|---|---|---| -| `clientId` | Your account's OAuth client_id | `qr-93-550e8400` | -| `clientSecret` | OAuth client_secret | `a1b2c3d4...` | -| `certificatePem` | X.509 certificate on a single line (no line breaks, with literal `\n`) | `-----BEGIN CERTIFICATE-----\n...` | - -## Suggested Flow - -The collection is organized in the typical order of use: - -1. **Auth → Generate Token** — run this first. The response automatically saves the `access_token` to an environment variable. -2. **SPEI → Cash-In** — creates a simulated charge to confirm the token is working. -3. **Webhooks Config → Test** — fires a test webhook at your endpoint. - -## Available Folders - -- `Auth` — JWT generation -- `SPEI` — cash-in, cash-out -- `Balance` — balance query -- `Webhooks Config` — list, create, test, delete - -## Alternatives - -Prefer another tool? - -- **Insomnia**: import the same `.json` (Postman v2.1 compatible) -- **OpenAPI / Bruno**: use our [`openapi.json`](/api-reference/openapi.json) directly -- **cURL**: every endpoint page in this documentation has a ready-to-copy cURL example - -## Support - -`suporte@ntxpay.com` diff --git a/es/guides/postman-collections.mdx b/es/guides/postman-collections.mdx deleted file mode 100644 index 2c77529..0000000 --- a/es/guides/postman-collections.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: 'Colecciones Postman' -description: 'Importa la colección oficial de Postman para probar la API NTX Pay localmente.' -mode: 'wide' ---- - -## Cómo obtener la colección - -La colección oficial de Postman con todos los endpoints públicos de NTX Pay México se distribuye bajo demanda. Solicita el archivo `.json` (Postman v2.1) por correo a `suporte@ntxpay.com`. - -## Importar en Postman - -1. Abre Postman -2. **File → Import** -3. Selecciona el archivo `.json` recibido -4. Importa también el environment proporcionado y elige **Sandbox** para iniciar las pruebas - -## Configurar Variables del Environment - -El environment espera 3 variables: - -| Variable | Descripción | Ejemplo | -|---|---|---| -| `clientId` | OAuth client_id de tu cuenta | `qr-93-550e8400` | -| `clientSecret` | OAuth client_secret | `a1b2c3d4...` | -| `certificatePem` | Certificado X.509 en una sola línea (sin saltos, con `\n` literal) | `-----BEGIN CERTIFICATE-----\n...` | - -## Flujo Sugerido - -La colección está organizada en el orden típico de uso: - -1. **Auth → Generate Token** — ejecútalo primero. El response guarda automáticamente el `access_token` en una variable de environment. -2. **SPEI → Cash-In** — crea un cobro simulado para confirmar que el token está funcionando. -3. **Webhooks Config → Test** — dispara un webhook de prueba en tu endpoint. - -## Carpetas Disponibles - -- `Auth` — generación de JWT -- `SPEI` — cash-in, cash-out -- `Balance` — consulta de saldo -- `Webhooks Config` — listar, crear, probar, eliminar - -## Alternativas - -¿Prefieres otra herramienta? - -- **Insomnia**: importa el mismo `.json` (compatible con Postman v2.1) -- **OpenAPI / Bruno**: usa nuestro [`openapi.json`](/api-reference/openapi.json) directamente -- **cURL**: cada página de endpoint en esta documentación tiene un ejemplo cURL listo para copiar - -## Soporte - -`suporte@ntxpay.com` diff --git a/pt-br/guides/postman-collections.mdx b/pt-br/guides/postman-collections.mdx deleted file mode 100644 index 863798b..0000000 --- a/pt-br/guides/postman-collections.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: 'Coleções Postman' -description: 'Importe a coleção oficial do Postman para testar a API NTX Pay localmente.' -mode: 'wide' ---- - -## Como obter a coleção - -A coleção oficial do Postman com todos os endpoints públicos da NTX Pay México é distribuída sob demanda. Solicite o arquivo `.json` (Postman v2.1) por e-mail para `suporte@ntxpay.com`. - -## Importar no Postman - -1. Abra o Postman -2. **File → Import** -3. Selecione o arquivo `.json` recebido -4. Importe também o environment fornecido e escolha **Sandbox** para iniciar os testes - -## Configurar Variáveis do Environment - -O environment espera 3 variáveis: - -| Variável | Descrição | Exemplo | -|---|---|---| -| `clientId` | OAuth client_id da sua conta | `qr-93-550e8400` | -| `clientSecret` | OAuth client_secret | `a1b2c3d4...` | -| `certificatePem` | Certificado X.509 em uma única linha (sem quebras, com `\n` literal) | `-----BEGIN CERTIFICATE-----\n...` | - -## Fluxo Sugerido - -A coleção está organizada na ordem típica de uso: - -1. **Auth → Generate Token** — execute primeiro. O response salva automaticamente o `access_token` em uma variável de environment. -2. **SPEI → Cash-In** — cria uma cobrança simulada para confirmar que o token está funcionando. -3. **Webhooks Config → Test** — dispara um webhook de teste no seu endpoint. - -## Pastas Disponíveis - -- `Auth` — geração de JWT -- `SPEI` — cash-in, cash-out -- `Balance` — consulta de saldo -- `Webhooks Config` — listar, criar, testar, deletar - -## Alternativas - -Prefere outra ferramenta? - -- **Insomnia**: importe o mesmo `.json` (compatível com Postman v2.1) -- **OpenAPI / Bruno**: use nosso [`openapi.json`](/api-reference/openapi.json) diretamente -- **cURL**: toda página de endpoint nessa documentação tem um exemplo cURL pronto pra copiar - -## Suporte - -`suporte@ntxpay.com`