Este artículo contiene un glosario de términos, abreviaturas y acrónimos específicos de la API de GoCardless con los que puede que te encuentres en nuestro producto/servicio. No dudes en ponerte en contacto con nosotros a través de api@gocardless.com si nos hemos olvidado de algún término o si tienes alguna otra pregunta.
A
Token de acceso: un identificador único de un negocio que solicita acceso a la API. Un negocio puede generar un token de acceso en el panel de control. Cuando se realiza una solicitud, podemos asociar el token proporcionado con el que tenemos almacenado, para autenticar e identificar al negocio solicitante.
API: un puente entre dos sistemas que normalmente no trabajarían juntos. Por ejemplo, sistemas que no tienen un lenguaje común con cual que comunicarse.
Aplicación: la representación de la integración de un asociado.
Tarifa de aplicación: una tarifa que los asociados pueden cargar además de las tarifas que GoCardless aplica sobre la base de las transacciones.
C
Identificador de cliente: se utiliza para autenticar e identificar una aplicación de asociado durante el flujo de OAuth.
Biblioteca de cliente: un conjunto de códigos que los desarrolladores pueden añadir a sus proyectos de desarrollo. Proporciona fragmentos de código que hacen las cosas básicas que una aplicación debe llevar a cabo para interactuar con la API, lo que permite al desarrollador ahorrar tiempo y trabajo.
Secreto de cliente: se utiliza para autenticar e identificar una aplicación de asociado durante el flujo de OAuth.
Página de pago personalizada: una página de pago hospedada por el propio integrador. Los integradores que utilizan páginas de pago personalizadas normalmente no emplearán el flujo de redirección.
E
Extremo: simplemente es uno de los extremos de un canal de comunicación con la API. Por ejemplo, para hacer solicitudes relacionadas con suscripciones, se utilizaría el extremo /subscriptions.
H
Encabezado HTTP: los encabezados HTTP son los pares nombre-valor que aparecen en los mensajes de solicitud y respuesta de los encabezados de mensajes del protocolo de transferencia de hipertexto (http). Para realizar unasolicitud HTTP a la API, se necesitan encabezados de Authorization, GoCardless-Version, Accept y Content-Type.
I
Clave de idempotencia: un encabezado que se puede añadir a cualquier solicitud a la API para evitar que la misma solicitud se realice más de una vez. Toda solicitud para crear un recurso que tenga una clave que ya se haya utilizado anteriormente no se completará correctamente y generará una respuesta con un error 409 idempotent_creation_conflict.
Integración: un sistema que utiliza la API para crear y administrar recursos, como, por ejemplo, un sitio web, un software de administración de relaciones con el cliente, un software de contabilidad, un sistema de gestión de contenidos, etc.
J
Flujo de Javascript: los negocios con páginas de pago personalizadas los utilizan para almacenar de forma segura la información bancaria de los clientes en nuestro servidor.
JSON: un formato de intercambio de datos de lenguaje natural y ligero. Es el formato que se utiliza para enviar y recuperar la mayoría de los datos a través de la API.
M
Metadatos: un conjunto de datos que describen y proporcionan información sobre otros datos. Se pueden utilizar para añadir datos personalizados sobre un cliente, un pago, una suscripción y determinadas acciones, como reintentar un pago.
O
OAuth: OAuth permite a un asociado trabajar con las cuentas de GoCardless de otros usuarios. Si dispones de la aprobación del usuario, puedes utilizar la API de GoCardless en su nombre y recibir sus webhooks.
P
Lista-paginada: cuando se realiza una solicitud para obtener una lista de recursos de la API, la cantidad de recursos que se devuelven está limitada. Si los resultados superan el límite, la API devuelve una lista paginada que permite realizar solicitudes adicionales para recuperar todos los resultados.
URL tras la incorporación: durante el flujo de OAuth, puedes comprobar si un negocio ya se ha verificado. Si todavía no lo ha hecho, puedes enviarle el flujo posterior a la incorporación para verificar la cuenta. Cuando haya finalizado el flujo de incorporación, se le redirigirá a la URL tras la incorporación que puedes definir en tu aplicación.
Token de acceso publicable: durante el flujo de JavaScript, el token de acceso publicable se incrusta en un formulario de pago. Cuando se envía el formulario, el token de acceso publicable se utiliza para obtener un token de cuenta bancaria del cliente para recuperar el identificador recién creado de la cuenta bancaria hospedada en nuestros servidores.
R
Flujo de redirección: los flujos de redirección te permiten utilizar las páginas de pago hospedadas de GoCardless para configurar mandatos con los clientes.
URL de redirección: la URL a la que se reenvía a un cliente después de que haya introducido sus datos de pago a través del flujo de redirección.
Identificador de solicitud: todas las solicitudes realizadas a través de nuestra API se pueden identificar de forma única por medio de la Identificador de solicitud.
Extremo restringido: un extremo que solo es accesible a los negocios/asociados que tengan activadas páginas de pago personalizadas.
Participación en los ingresos: un porcentaje de participación que los asociados pueden obtener del cargo por transacción de la tarifa de GoCardless.
S
Simulador de escenarios: nombres de clientes especiales que se pueden utilizar en el entorno de la cuenta de pruebas para desencadenar secuencias de eventos de forma casi instantánea.
Token de sesión: un identificador aleatorio que se debe proporcionar cuando se crea el flujo de redirección y nuevamente cuando se completa. Esto permite que los integradores se aseguren de que el usuario al que se envió originalmente a las páginas de pago de GoCardless sea el que las ha rellenado.
T
Webhook de prueba: un webhook que se puede enviar manualmente con datos ficticios del entorno de la cuenta de pruebas.
W
Webhook: un webhook es una solicitud que GoCardless envía al servidor del negocio para avisarle de un evento. Esto permite a los negocios recibir notificaciones de GoCardless en tiempo real cada vez que sucede algo en sus cuentas, de modo que puedan llevar a cabo acciones automatizadas en respuesta
Secreto de webhook: un identificador único que se utiliza para identificar y autenticar un extremo de webhook. Se utiliza en las firmas de webhooks para asegurarse de que el webhook enviado sea original.