lyra.com
Buscar
Categoria
Tags
España
Francia
España
Europe (English)
India
Implementación
Formulario incrustado
Servicios web REST
Formulario de pago
Intercambio de ficheros
Servicios web
Pago móvil
Ayuda y herramientas
Módulos de pago
FAQ
Guías
Back office
SUPPORT

Utilizar el Web Service

Cada solicitud se compone de los siguientes elementos:
  • Una URL (o " endpoint ") solicitada
  • un método
  • encabezados (o " headers ")
  • datos (o " body ")

El punto de entrada (endpoint)

El punto de entrada ( root-endpoint ) de API es: https://secure.lyra.com/sdd .

Se ponen a disposición varios recursos asociados cada uno a un camino ( path ) diferente:

Acción Método URl
Importar un mandato existente POST /mandates
Importar varios mandatos existentes POST /multimandates
Consultar los datos de un mandato GET /mandates/:id
Descargar un mandato GET /mandates/:id
Actualizar un mandato PUT /mandates/:id
Eliminar un mandato DELETE /mandates/:id

(  : ) en el camino indica una variable. Debe reemplazar esta variable por un valor real cuando envía su solicitud. En nuestro caso, debe reemplazar  :id por la ID del mandato que usted desea utilizar.

El método

Cada recurso es accesible a través de un método específico. Este método traduce la acción que usted desea realizar (ver tabla a continuación).

  • GET Esta solicitud se utiliza para obtener un recurso desde el servidor.
  • POST Esta solicitud se utiliza para crear un nuevo recurso.
  • PUT Esta solicitud se utiliza para actualizar un nuevo recurso.
  • DELETE Esta solicitud se utiliza para eliminar un recurso.

Los encabezados

Los encabezados HTTP son pares de clave-valores separados por " : ".

Se utilizan para transmitir los datos de autenticación y de las informaciones sobre el contenido de la solicitud.

Los encabezados utilizados en esta API se describen en el capítulo Identificarse durante los intercambios .

Los datos (o "body")

Los datos (también llamados "body" o "mensaje") contienen las informaciones que usted desea transmitir al servidor. Solo se utilizan en las solicitudes POST y PUT .

En las solicitudes y respuestas, los datos se transmiten en formato JSON (Javascript Object Notation). En este formato, cada propiedad y valor se enmarcan por dobles cuotas:

 {
"propiedad1": "valor1",
"propiedad2": "valor2"
 }

Probar el web service con cURL

Esta parte supone que usted ya ha instalado cURL .

Para utilizar cURL, escribir curl seguido del endpoint que desea interrogar.

Ejemplo recurriendo a nuestro root-endpoint:

 curl https://secure.lyra.com/sdd

Al realizar la validación, usted obtiene la siguiente respuesta:

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<html><head>
<title>404 Not Found</title>
</head><body>
<h1>Not Found</h1>
<p>The requested URL /sdd was not found on this server.</p>
<p>Additionally, a 404 Not Found
error was encountered while trying to use an ErrorDocument to handle the request.</p>
</body></html>

Para obtener la lista de los mandatos registrados en su tienda, modificar la línea de pedido precedente especificando el endpoint " /mandates ” :

 curl https://secure.lyra.com/sdd/mandates

Usted obtendrá la siguiente respuesta:

 {
  "name" : "ERROR",
  "message" : "Service error",
  "details" : "RESTEASY001545: No resource method found for GET, return 405 with Allow header"
 }

Obtiene esta respuesta ya que no se ha autentificado.

Ahora descubramos cómo autentificarse utilizando los encabezados HTTP.

Contratación

Head Office :

LYRA NETWORK
109, rue de l’innovation
31670 Labège
FRANCE