Como funciona
Si no es un desarrollador, lea este artículo, le facilitará mucho el uso de API 2.0.
Puede crear una factura realizando una solicitud a la API de servicio mediante programación.
La solicitud se envía mediante el método POST en el formato URLencode a la dirección: https://username.soloclic.com/api/createorder, donde username es el inicio de sesión del usuario en el sistema y su dominio de tercer nivel en el servicio Soloclic.
En respuesta a la solicitud, su sistema recibirá el resultado de la ejecución de la función en formato JSON. Por ejemplo, algo como esto:
{"error_code":0,"error_text":"OK","result":[],"hash":"******************************"}
Para obtener más información, consulte el artículo «Respuestas de API de servicio«.
Parámetros recibidos en respuesta
Obtendrá una matriz de resultados con objetos. Cada objeto es un grupo. Se enumerará lo siguiente:
- rpsKey – clave API; la clave de su cuenta se encuentra en la sección «Integración y API», el enlace a la sección está en el pie de página de su cuenta personal o aquí /shops/setts/apisettings/
- customer_email: correo electrónico del contacto al que se emite la factura; línea
- customer_first_name – nombre de contacto; línea
- customer_last_name – apellido de contacto; línea
- customer_middle_name – segundo nombre del contacto; línea
- customer_phone – número de teléfono de contacto; línea
- order_ip – cadena (dirección IP de cuenta / contacto)
- customer_shipping- dirección de envío; línea
- customer_shipping_phone: número de teléfono del cliente; línea
- customer_shipping_address_2 – dirección de envío (recomendado como campo adicional en caso de direcciones complejas); línea
- customer_shipping_city – dirección de envío (recomendado para una ciudad); línea
- customer_shipping_state – dirección de envío (recomendada para región / estado); línea
- customer_shipping_zip – dirección de envío (recomendada para zip); línea
- customer_shipping_country_code = string ([códigos de país ISO] (https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes), por ejemplo, «EE. UU.», «CA», etc.)
- customer_billing_address_1 – cadena
- customer_billing_address_2 – cadena
- customer_billing_city – cadena
- customer_billing_state – cadena
- customer_billing_zip – cadena
- customer_billing_country_code: código del país de entrega; línea; enviar en el formato [códigos de país ISO] (p. ej., «EE. UU.», «CA», etc.), será reemplazado automáticamente por el país (por ejemplo, «EE. UU.» se convertirá en «Estados Unidos de América»)
- order_tag: etiqueta de cuenta, solo puede haber una (no confundir con la etiqueta de contacto); línea
- note: una nota a la cuenta, visible en la tarjeta de la cuenta; línea
- order_created_at: fecha y hora en que se creó la factura (30.01.2020 04:22:16 o 2019-07-30 04:22:16); línea
- order_paid_at: fecha y hora del pago de la factura (30.01.2020 04:22:16 o 2019-07-30 04:22:16); línea
- order_status: el estado de la cuenta creada / modificada (Esperada, Pagada, Cancelar o Devolución de dinero); línea
- order_confirmed: si la cuenta está confirmada o no (Sí, No, Verdadero, Falso o Confirmado); línea
- order_sales_manager: identificación del gerente personal del contacto (la identificación se toma del enlace de edición del empleado /shops/access/)
- product_names – parámetro obligatorio; id de los productos incluidos en la factura; valores separados por comas (tomados del enlace del enlace a la página del pedido)
- product_prices – parámetro opcional, precio del producto; valores separados por comas; si no lo especifica, el precio se tomará de la configuración del producto en su cuenta personal; si hay 5 productos en la factura, y solo se indican claramente 3 precios, entonces los dos últimos nombres estarán con el precio de la configuración en la cuenta personal (en un producto específico)
Payment_method – cadena (PayPal, Stripe) - coupon: ID del cupón de descuento (de la barra de direcciones al editar el cupón en su cuenta personal; también puede obtener el método getcoupons); línea
- affiliates: inicios de sesión de socios; línea; separado por comas; el socio indicado primero será socios del primer nivel, el segundo, el segundo, y así sucesivamente.
- utm_medium: etiqueta utm, cadena
- utm_source – etiqueta utm, cadena
- utm_campaign – etiqueta utm, cadena
- utm_content – etiqueta utm, cadena
- utm_term – etiqueta utm, cadena
En un futuro próximo, este método también podrá trabajar con campos adicionales que puede crear en CRM.
Ejemplo de PHP (cURL)
<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://username.soloclic.com/api/createorder', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => 'rpsKey=>customer_email=>customer_first_name=>customer_last_name=>customer_middle_name=>customer_phone=>order_ip=>customer_shipping=>customer_shipping_phone=>customer_shipping_address_2=>customer_shipping_city=>customer_shipping_state=>customer_shipping_zip=>customer_shipping_country_code=>customer_billing_address_1=>customer_shipping_city=>customer_shipping_state=>customer_shipping_zip=>customer_billing_address_1=>customer_billing_address_2=>customer_billing_city=>customer_billing_state=>customer_billing_zip=>customer_billing_country_code=>order_tag=>note=>order_created_at=>order_paid_at=>order_status=>order_confirmed=>order_sales_manager=>product_prices=>payment_method=>coupon=>affiliates=>utm_medium=>utm_source=>utm_campaign=>utm_content=>utm_term=', CURLOPT_HTTPHEADER => array( 'Content-Type: application/x-www-form-urlencoded' ), )); $response = curl_exec($curl); curl_close($curl); echo $response;