1. IntegrationMarketplace
Firma Virtual México - Clientes API
  • API
    • OAuth2
      • tokenExchange
      • getAuthorizationServerInfo
      • authMe
    • IntegrationMarketplace
      • marketplaceSetup
        GET
      • marketplaceProvision
        GET
      • marketplaceAuthorize
        GET
    • Documents
      • createDocument
      • getAllDocumentsByMe
      • getDocumentByIdAndMe
      • getDocumentStatisticsByMe
    • Files
      • uploadBiometryFiles
      • downloadByFileName
      • downloadBiometryMedia
    • Signatures
      • signDocument
    • SignatureCreditAccount
      • getSignatureCreditAccountByMe
    • SignatureCreditAccountMovement
      • getAllSignatureCreditAccountMovementsByMe
      • getSignatureCreditAccountMovementByIdAndMe
    • PurchaseOrder
      • getAllPurchasesByMe
    • SignaturePackages
      • getAllPackages
    • Mails
      • forwardBiometricValidation
    • SubUsers
      • getAllSubusersByMe
      • createSubuserByMe
    • SubClients
      • getAllSubclientsByMe
      • createSubclientByMe
  1. IntegrationMarketplace

marketplaceSetup

GET
https://demo-apimex.firmavirtual.mx/api/marketplace/setup

marketplaceSetup#

Endpoint que inicia el flujo de instalación/aprovisionamiento de la app Firma Virtual México cuando se instala desde un marketplace o ERP de terceros (p.ej. Shopify, Odoo, Monday). Recibe, como parámetros de consulta, el código de la aplicación de integración, un identificador externo de la tienda o cuenta origen y los datos de contacto del cliente, con los que se prepara el registro inicial antes de continuar con el aprovisionamiento (marketplaceProvision) y la autorización (marketplaceAuthorize).
URL: /api/marketplace/setup
METHOD: GET
PARAMS:
ClaveTipoRequeridoDescripción
integration_app_codestringSíCódigo de la aplicación de integración que se está instalando.
external_idstringSíIdentificador único de la instalación en la plataforma origen (tienda, cuenta u organización).
shop_domainstringSíDominio o URL de la tienda/cuenta desde la que se realiza la instalación.
client_namestringSíNombre del cliente o empresa que está instalando la integración.
client_rfcstringNoRFC del cliente o empresa que está instalando la integración.
emailstringSíCorreo electrónico de contacto del cliente.
first_namestringSíNombre(s) del contacto principal.
last_namestringSíApellido paterno del contacto principal.
mother_last_namestringNoApellido materno del contacto principal.
phonestringNoNúmero de teléfono del contacto principal.
RESPONSE
{}

Solicitud

Parámetros de consulta

Respuestas

🟢200Éxito
application/json
Bodyapplication/json

Solicitud Ejemplo de Solicitud
Shell
JavaScript
Java
Swift
curl --location 'https://demo-apimex.firmavirtual.mx/api/marketplace/setup?integration_app_code=&external_id=&shop_domain=&client_name=&email=&first_name=&last_name=&phone='
Respuesta Ejemplo de Respuesta
{}
Modificado en 2026-08-24 20:03:01
Anterior
IntegrationMarketplace
Siguiente
marketplaceProvision
Built with