SOAP API: autenticación y App Keys

Crear App Keys, obtener un SecurityToken y realizar solicitudes SOAP autenticadas en la API legacy de eConnect.

Antes de poder utilizar la API SOAP legacy, necesita App Keys y debe obtener un SecurityToken a través del endpoint Login. Este artículo explica paso a paso cómo funciona.

Importante: Esta es la API SOAP legacy. Para nuevas integraciones recomendamos la REST API, que utiliza OAuth 2.0.

Crear App Keys

Las App Keys consisten en un Consumer Key y un Consumer Secret. Se crean en la plataforma eConnect a través del menú Verbindingen (Conexiones). Para esto necesita un rol de administrador.

Hay dos tipos de apps disponibles:

TipoVisibilidadDescripciónGeneric AppPúblicoEl nombre está predefinido por eConnect. Adecuada para integraciones estándar.Own AppPrivadoUsted elige el nombre y opcionalmente un logotipo. Adecuada para conexiones personalizadas.

Para la variante de contable se utilizan App Integration Requests: el cliente otorga a través de la plataforma permiso para acceder a su administración. Esto es relevante si usted trabaja como proveedor de software en nombre de varios clientes.

Flujo de autenticación

La autenticación se realiza en dos pasos:

Paso 1: Login

Llame al endpoint Login con su Consumer Key y Consumer Secret. Recibirá un SecurityToken como respuesta.

<Login>
  <ConsumerKey>jouw-consumer-key</ConsumerKey>
  <ConsumerSecret>jouw-consumer-secret</ConsumerSecret>
</Login>

Paso 2: Incluir el SecurityToken

Incluya el SecurityToken en el encabezado SOAP en todas las solicitudes posteriores. El token es válido durante 4 horas. También puede solicitar un nuevo token por sesión.

<soap:Header>
  <SecurityToken>ontvangen-security-token</SecurityToken>
</soap:Header>

Paso 3: Obtener información de la cuenta

Después de un login exitoso, llame a GetAccountParties para obtener su EConnectPartyId (número XCNL). Este ID es necesario para enviar y recibir documentos.

Endpoint y WSDL
CaracterísticaValorEndpointhttps://api.everbinding.nl/soap/v3.1?subscriptionKey={subscriptionKey}WSDLDisponible a través de [email protected]ProtocoloSOAP 1.1 sobre HTTPS/SSL

El WSDL contiene la especificación completa de todos los endpoints disponibles, tipos de datos y códigos de error. Puede importar el WSDL en herramientas como SoapUI o Visual Studio para generar código de cliente automáticamente.

Errores frecuentes

Transfer-Encoding=chunked: la API SOAP no es compatible con chunked transfer encoding. Asegúrese de que su cliente HTTP envíe el encabezado content-length en lugar de utilizar chunked encoding. Este es uno de los errores de implementación más frecuentes.

Token expirado: si su SecurityToken tiene más de 4 horas, recibirá un error de autenticación (serie de código de error 600). Solicite un nuevo token a través de Login.

Sin subscriptionKey: sin una subscriptionKey válida en la URL del endpoint, todas las solicitudes serán rechazadas. Verifique que la clave sea correcta y esté activa.

Error handling

La API SOAP devuelve códigos de error estructurados en el formato ERR + opcode + serie + ID. Las series de códigos de error indican el tipo de error:

SerieTipo100Warning200Funcional300Permisos400Validación600Autenticación800Comunicación900Desconocido

¿Está considerando migrar a OAuth2 y la REST API? Consulte la documentación de PSB en psb.econnect.eu para el flujo de autenticación moderno.

Migrar a la REST API

Relacionado