Inicio Rápido

Usando la API OnSpot PLATFORMS

4. Documentación de la API

Una vez obtenidos el publicKey y secretKey:

• Accede a la documentación de la API a través del enlace proporcionado en el correo de registro, o desde la sección Documentación de la API dentro de la plataforma OnSpot.

5. Endpoints Disponibles

La API proporciona dos endpoints principales:

1. Generate Token - Para obtener un token de autenticación.
2. Create Payouts - Para enviar pagos a usuarios.

Endpoint 1: Generate Token

URL: https://api.onspotintl.com/platform/generate-token-api

6. Cómo Usar

Para consumir el endpoint Generate Token:

• Agrega los siguientes headers:
  • publicKey: Tu clave pública.
  • secretKey: Tu clave secreta.
  • environment: Especifica "test" o "live" para indicar el entorno.

⚠️ Cada entorno tiene sus propias claves únicas. Asegúrate de usar el par correcto para el entorno.

Ejemplo de Solicitud Postman

Ejemplo de Solicitud cURL

curl -X POST https://api.onspot.com/auth/generate-token \
-H "publicKey: tu-clave-publica" \
-H "secretKey: tu-clave-secreta" \
-H "environment: live"

Ejemplo de Respuesta

• En caso de éxito:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwdWJsaWNLZXkiOiIyOTAzZDNkNWY3YTQ2ZWM4NGM2MmRlNzg4NWNhYWQzODEzMWU5ZGFhMGI1NDkyZGFhOTVhYTg1NjE5YWMzNjdkIiwiaWQiOiJmNzk3YWIyNi1mMTBlLTc1YTUtYWFhZi0yMTM4Mzc4Mjk0MmUiLCJpYXQiOjE3MzI5NjU5NDgsImV4cCI6MTczMjk2OTU0OH0.2VQRklfR-srrdld4BpBdKfHpFeqeA-84l8rUj4KOAXQ"

El token es válido por una hora y debe ser usado para las siguientes llamadas a la API.

Endpoint 2: Create Payouts

URL: https://api.onspotintl.com/accreditation/payouts/create

7. Cómo Usar

Para consumir el endpoint Create Payouts:

• Agrega los siguientes headers:
  • Authorization: Incluye el token previamente generado como Bearer Token.
  • environment: Especifica "test" o "live" para indicar el entorno.

⚠️ Los tokens son específicos del entorno. Un token generado para "test" no puede ser usado en "live", y viceversa.

• Incluye el payload en el cuerpo como un array de objetos que representan los pagos.

Ejemplo de Solicitud Postman

⚠️ ADVERTENCIA: documentType ENUM contiene

{
// Documento Nacional de Identidad:
// Usado en muchos países (ej. Perú, Argentina, España) como forma principal de identificación.
DNI = 'DNI',

// Pasaporte:
// Documento de viaje emitido por el gobierno de un país para viajes internacionales y verificación de identidad.
PASSPORT = 'PASSPORT',

// Registro Único de Contribuyentes:
// Usado en países como Perú para identificación tributaria de individuos y empresas.
RUC = 'RUC',

// Carné de Extranjería:
// Usado en algunos países (ej. Perú) para identificar residentes extranjeros que permanecen legalmente en el país.
CE = 'CE',

// Número de Identificación Tributaria:
// Usado en algunos países (ej. Colombia) para propósitos tributarios e identificación empresarial.
NIT = 'NIT',

// Registro Único Tributario:
// Documento tributario similar usado en países como Colombia para identificar contribuyentes.
RUT = 'RUT',

// Cédula de Ciudadanía:
// Documento de identificación principal para ciudadanos en países como Colombia.
CC = 'CC',

// Permiso de Protección Temporal:
// Usado en países como Colombia para otorgar estatus legal temporal a migrantes.
PPT = 'PPT',
}

Ejemplo de Solicitud cURL

curl -X POST https://api.onspot.com/accreditation/payouts/create \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
-H "environment: live" \
-H "Content-Type: application/json" \
-d '[
{
"type": "BUSINESS",
"documentType": "PASSPORT",
"documentNumber": "75798566878",
"legalName": "TestStudio",
"businessRepresentative": {
"firstName": "",
"lastName": ""
},
"customerEmail": "teststudio@yopmail.com",
"amount": "6700",
"currency": "USD",
"description": "Testing"
},
{
"type": "INDIVIDUAL",
"documentType": "CC",
"documentNumber": "1017209836",
"legalName": "",
"firstName": "Aries",
"lastName": "Studio",
"customerEmail": "eduardmarbell193777@hotmail.com",
"amount": "98l00",
"currency": "USD",
"description": "Testing10"
}
]'

Ejemplo de Respuesta

• En caso de éxito:

[
[
{
"uuid": "068ee2eb-2442-4198-b07b-819385d7e13d",
"email": "pruebasuserapionspot@yopmail.com",
"action": "success",
"message": "created successfully"
},
{
"uuid": "0bd9137c-31e1-4af3-9465-e17bf53a4f20",
"email": "studioTesting@yopmail.com",
"action": "success",
"message": "created successfully"
}
]
]

---

Confirmando Datos o Errores

8. Verificar Pagos y Logs de Errores

• Usa la plataforma OnSpot para:
  • Ver pagos exitosos en la sección Payouts.
  • Verificar la sección Error Logs para cualquier problema.
• Cambia entre entornos "test" y "live" usando el botón de alternancia en la parte superior de la plataforma.

⚠️ Los datos de "test" no aparecerán cuando la plataforma esté en modo "live", y viceversa.

---

Recomendaciones Finales

9. Notas Importantes

• Contactar Soporte: La información de contacto del BackOffice de OnSpot está disponible en la plataforma para cualquier asistencia.
• Transferencias Bancarias: Usa la información bancaria proporcionada en la plataforma para hacer transferencias a OnSpot.
  • Si el monto transferido es menor que la suma de pagos creados en PROD, OnSpot activará pagos solo hasta el saldo transferido.

Subsecciones

• Generar Token - Generación detallada de token
• Crear Pagos - Creación detallada de pagos
• Obtener Información - Recuperación de información de la plataforma
• Obtener Bancos OnSpot - Información de bancos disponibles
• Obtener Saldos - Información de saldos
• Obtener Pagos - Recuperar todos los pagos