Merge pull request #65 from placetopay-org/3dss-doc

3dss doc
placetopay-org · Jul 16, 2024 · 25ae75e · 25ae75e
2 parents 20b0664 + 7fd02c9
commit 25ae75e
Show file tree

Hide file tree

Showing 27 changed files with 6,068 additions and 37 deletions.
diff --git a/src/assets/apis/three-d-s-server/en.yaml b/src/assets/apis/three-d-s-server/en.yaml
diff --git a/src/assets/apis/three-d-s-server/es.yaml b/src/assets/apis/three-d-s-server/es.yaml
diff --git a/src/constants/navigations.js b/src/constants/navigations.js
@@ -372,14 +372,37 @@ export const TAB_NAVIGATION = {
       {
         title: 'API',
         identifier: 'three-d-s-server/api',
-        href: '/three-d-s-server/api/',
+        href: '/three-d-s-server/api',
         icon: DocumentCode,
         links: [
           {
-            title: '',
+            title: 'Introducción',
+            links: [
+                { title: 'Inicio', href: '/three-d-s-server/api' },
+                { title: 'Teléfono', href: '/three-d-s-server/api/phone-properties' },
+                { title: 'Información de Autenticación 3DS', href: '/three-d-s-server/api/three-d-s-authentication-info' },
+                { title: 'Información de Cuenta', href: '/three-d-s-server/api/acct-info' },
+                { title: 'Indicador de Riesgo del Comerciante', href: '/three-d-s-server/api/risk-indicator' },
+                { title: 'Información de Autenticación Previa 3DS', href: '/three-d-s-server/api/requestor-prior-authentication-info' }
+            ],
+          },
+          {
+            title: 'Sesiones',
+            links: [
+              { title: 'Gestor de sesiones', href: '/three-d-s-server/api/sessions/session' },
+            ],
+          },
+          {
+            title: 'Transacciones',
+            links: [
+              { title: 'Gestor de transacciones', href: '/three-d-s-server/api/transactions/show' },
+            ],
+          },
+          {
+            title: 'Comercios',
             links: [
-              { title: '', href: '' },
-              { title: '', href: '' },
+              { title: 'Gestor de comercios', href: '/three-d-s-server/api/merchants/create' },
+              { title: 'Gestor de sucursales', href: '/three-d-s-server/api/merchants/branch' },
             ],
           },
         ],
@@ -443,15 +466,31 @@ export const TAB_NAVIGATION = {
         title: "API",
         identifier: "three-d-s-server/api",
         href: "/three-d-s-server/api/",
-        icon: "DocumentCode",
+        icon: DocumentCode,
         links: [
           {
-            title: "",
+            title: 'Sessions',
             links: [
-              { "title": "", "href": "" },
-              { "title": "", "href": "" }
-            ]
-          }
+              { title: 'Home', href: '/three-d-s-server/api' },
+              { title: 'Phone Properties', href: '/three-d-s-server/api/phone-properties' },
+              { title: '3DS Authentication Info', href: '/three-d-s-server/api/three-d-s-authentication-info' },
+              { title: 'Account Info', href: '/three-d-s-server/api/acct-info' },
+              { title: 'Merchant Risk Indicator', href: '/three-d-s-server/api/risk-indicator' },
+              { title: '3DS Prior Authentication Info', href: '/three-d-s-server/api/requestor-prior-authentication-info' }            ],
+          },
+          {
+            title: 'Transactions',
+            links: [
+              { title: 'Transaction manager', href: '/three-d-s-server/api/transactions/show' },
+            ],
+          },
+          {
+            title: 'Merchants',
+            links: [
+              { title: 'Merchants manager', href: '/three-d-s-server/api/merchants/create' },
+              { title: 'Branches manager', href: '/three-d-s-server/api/merchants/branch' },
+            ],
+          },
         ]
       }
     ]

diff --git a/src/pages/en/three-d-s-server/api/acct-info.mdx b/src/pages/en/three-d-s-server/api/acct-info.mdx
@@ -0,0 +1,240 @@
+<MissingTranslationBanner />
+
+# Documentación de `acctInfoProperties`
+
+## Descripción
+
+`acctInfoProperties` es un objeto que proporciona información adicional sobre la cuenta del titular de la tarjeta.
+
+### Descripción del Objeto
+
+| Campo          | Descripción                                           |
+|----------------|-------------------------------------------------------|
+| **title**      | `acctInfo`                                            |
+| **type**       | `object`                                              |
+| **description**| Información adicional sobre la cuenta del titular de la tarjeta. |
+
+### Propiedades del Objeto
+
+#### `chAccAgeInd`
+
+- **Tipo:** `string`
+- **Descripción:** Longitud del tiempo en que la cuenta fue creada en el sitio web del comercio.
+
+  **Valores aceptados:**
+  - `01` - Sin cuenta (invitado)
+  - `02` - Creada durante la transacción
+  - `03` - Menos de 30 días
+  - `04` - Entre 30 y 60 días
+  - `05` - Más de 60 días
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'01'`
+
+#### `chAccChange`
+
+- **Tipo:** `string`
+- **Descripción:** Fecha del último cambio efectuado en la cuenta del tarjetahabiente en el sitio web del comercio.
+
+  **Formato:** `YYYYMMDD`
+
+  **Ejemplo de valor:** `'20210310'`
+
+- **Longitud:** 8 caracteres
+
+#### `chAccChangeInd`
+
+- **Tipo:** `string`
+- **Descripción:** Longitud del tiempo desde el último cambio efectuado en la cuenta en el sitio web del comercio.
+
+  **Valores aceptados:**
+  - `01` - Cambiado durante la transacción
+  - `02` - Menos de 30 días
+  - `03` - Entre 30 y 60 días
+  - `04` - Más de 60 días
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'02'`
+
+#### `chAccDate`
+
+- **Tipo:** `string`
+- **Descripción:** Fecha en la que se creó la cuenta en el sitio web del comercio.
+
+  **Formato:** `YYYYMMDD`
+
+  **Ejemplo de valor:** `'20210310'`
+
+- **Longitud:** 8 caracteres
+
+#### `chAccPwChange`
+
+- **Tipo:** `string`
+- **Descripción:** Fecha en la que se realizó el último cambio o recuperación de contraseña.
+
+  **Formato:** `YYYYMMDD`
+
+  **Ejemplo de valor:** `'20210310'`
+
+- **Longitud:** 8 caracteres
+
+#### `chAccPwChangeInd`
+
+- **Tipo:** `string`
+- **Descripción:** Longitud de tiempo desde el último cambio o recuperación de contraseña.
+
+  **Valores aceptados:**
+  - `01` - Sin cambios
+  - `02` - Cambiado durante la transacción
+  - `03` - Menos de 30 días
+  - `04` - Entre 30 y 60 días
+  - `05` - Más de 60 días
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'03'`
+
+#### `nbPurchaseAccount`
+
+- **Tipo:** `string`
+- **Descripción:** Número de compras durante los últimos 6 meses.
+
+- **Longitud:** 1 a 4 caracteres
+
+  **Ejemplo de valor:** `'1234'`
+
+#### `provisionAttemptsDay`
+
+- **Tipo:** `string`
+- **Descripción:** Número de intentos de agregar tarjetas en las últimas 24 horas.
+
+  **Ejemplos de valores aceptados:** `2`, `02`, `002`
+
+- **Longitud:** 1 a 3 caracteres
+
+  **Ejemplo de valor:** `'002'`
+
+#### `txnActivityDay`
+
+- **Tipo:** `string`
+- **Descripción:** Número de transacciones (exitosas y abandonadas) para esta cuenta en las últimas 24 horas.
+
+  **Ejemplos de valores aceptados:** `2`, `02`, `002`
+
+- **Longitud:** 1 a 3 caracteres
+
+  **Ejemplo de valor:** `'02'`
+
+#### `txnActivityYear`
+
+- **Tipo:** `string`
+- **Descripción:** Número de transacciones (exitosas y abandonadas) para esta cuenta en el último año.
+
+  **Ejemplos de valores aceptados:** `2`, `02`, `002`
+
+- **Longitud:** 1 a 3 caracteres
+
+  **Ejemplo de valor:** `'2'`
+
+#### `paymentAccAge`
+
+- **Tipo:** `string`
+- **Descripción:** Fecha en la que el método de pago se agregó a la cuenta del usuario en el sitio web del comercio.
+
+  **Formato:** `YYYYMMDD`
+
+  **Ejemplo de valor:** `'20210307'`
+
+- **Longitud:** 8 caracteres
+
+#### `paymentAccInd`
+
+- **Tipo:** `string`
+- **Descripción:** Longitud de tiempo desde que el método de pago fue enrolado en la cuenta en el sitio web del comercio.
+
+  **Valores aceptados:**
+  - `01` - Sin cuenta (invitado)
+  - `02` - Durante la transacción
+  - `03` - Menos de 30 días
+  - `04` - Entre 30 y 60 días
+  - `05` - Más de 60 días
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'01'`
+
+#### `shipAddressUsage`
+
+- **Tipo:** `string`
+- **Descripción:** Fecha en la que la dirección de entrega fue usada por primera vez en el sitio web del comercio.
+
+  **Formato:** `YYYYMMDD`
+
+  **Ejemplo de valor:** `'20210305'`
+
+- **Longitud:** 8 caracteres
+
+#### `shipAddressUsageInd`
+
+- **Tipo:** `string`
+- **Descripción:** Longitud de tiempo desde que la dirección de entrega fue usada por primera vez en el sitio web del comercio.
+
+  **Valores aceptados:**
+  - `01` - Esta transacción
+  - `02` - Menos de 30 días
+  - `03` - Entre 30 y 60 días
+  - `04` - Más de 60 días
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'02'`
+
+#### `shipNameIndicator`
+
+- **Tipo:** `string`
+- **Descripción:** Indica si el nombre del titular de la tarjeta es igual al nombre de envío usado en esta transacción.
+
+  **Valores aceptados:**
+  - `01` - Nombre de cuenta idéntico al nombre de envío.
+  - `02` - Nombre de cuenta diferente al nombre de envío.
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'01'`
+
+#### `suspiciousAccActivity`
+
+- **Tipo:** `string`
+- **Descripción:** Indica si el comercio ha experimentado actividad sospechosa (incluido fraude previo) en la cuenta del titular de la tarjeta.
+
+  **Valores aceptados:**
+  - `01` - No se ha observado actividad sospechosa.
+  - `02` - Se ha observado actividad sospechosa.
+
+- **Longitud:** 2 caracteres
+
+  **Ejemplo de valor:** `'02'`
+
+### Ejemplo de Petición
+
+```json
+{
+  "chAccAgeInd": "01",
+  "chAccChange": "20210310",
+  "chAccChangeInd": "02",
+  "chAccDate": "20210310",
+  "chAccPwChange": "20210310",
+  "chAccPwChangeInd": "03",
+  "nbPurchaseAccount": "1234",
+  "provisionAttemptsDay": "002",
+  "txnActivityDay": "02",
+  "txnActivityYear": "2",
+  "paymentAccAge": "20210307",
+  "paymentAccInd": "01",
+  "shipAddressUsage": "20210305",
+  "shipAddressUsageInd": "02",
+  "shipNameIndicator": "01",
+  "suspiciousAccActivity": "02"
+}
diff --git a/src/pages/en/three-d-s-server/api/index.mdx b/src/pages/en/three-d-s-server/api/index.mdx
@@ -0,0 +1,14 @@
+<MissingTranslationBanner />
+
+Este documento presenta el funcionamiento del servicio o la API del 3DS Server. Expone los endpoints a consumir (**/sessions** y **/transactions**), la url, el método, parámetros y los tipos de datos que recibe. Además, contiene ejemplos de respuestas para diferentes tipos de peticiones en el flujo de autenticación de un tarjetahabiente dentro del marco del protocolo 3-D Secure.
+
+**contact:**
+ - name: Evertec Placetopay
+ - email: desarrollo@placetopay.com
+ - url: 'https://www.placetopay.com/web/'
+
+**servers:**
+  - description: Sandbox
+    - url: 'https://3dss-test.placetopay.com/api'
+  - description: Producción
+    - url: 'https://3ds-mpi.placetopay.com/api'