Uso de la API #
A continuación se describen los comandos disponibles de la API, junto con ejemplos de solicitud-respuesta para cada punto final.
Utilizamos el valor del encabezado authtoken para la autenticación y el tipo multipart-form para las operaciones de datos (POST/PUT).
Si no estás familiarizado con las API REST, te recomendamos encarecidamente que contrates a un profesional para que realice las integraciones con tu aplicación externa .
Familiarizarse con las API REST es un requisito previo para este elemento, y su aprendizaje queda fuera del alcance de nuestro soporte .
Ejemplo de uso (comando de ejemplo) #
En este Escenario Su usaremos un token ficticio que representa su Token API real, el cual para este ejemplo será: jEheVytlAoFl7F8MqUQ7jAo2hOXAS y necesita enumerar todos los clientes disponibles de su Oficina Virtual Ofilany, a través de una
solicitud cURL.
Caso de uso : Deberá ejecutar el siguiente comando:
curl -H "authtoken: jEheVytlAoFl7F8MqUQ7jAo2hOXAS" https://dominio-tu-oficina-ofilany.com/api/customersLa respuesta que debes recibir, bajo un código de estado 200 OK, será similar a la siguiente:
[
{
"stripe_id" : null,
"active" : "1",
"vat" : "1234567890",
"address" : "Test Address",
"billing_country" : "0",
"phonenumber" : "1234567890",
"registration_confirmed" : "1",
"longitude" : null,
"billing_city" : "",
"state" : "Test State",
"shipping_zip" : "",
"billing_zip" : "",
"city" : "Test City",
"shipping_country" : "0",
"billing_street" : "",
"datecreated" : "2019-11-29 12:34:56",
"company" : "Jk Technologies",
"shipping_street" : "",
"zip" : "123456",
"billing_state" : "",
"leadid" : null,
"addedfrom" : "8",
"userid" : "3",
"default_language" : "english",
"shipping_state" : "",
"show_primary_contact" : "0",
"country" : "102",
"default_currency" : "3",
"shipping_city" : "",
"latitude" : null,
"website" : "https://example.com"
},
{
"website" : "https://example2.com",
"latitude" : null,
"default_currency" : "0",
"shipping_city" : "London",
"country" : "235",
"show_primary_contact" : "0",
"shipping_state" : "Greater London",
"default_language" : "",
"addedfrom" : "1",
"userid" : "1",
"leadid" : null,
"billing_state" : "Greater London",
"zip" : "WC1 ASW",
"shipping_street" : "123 Road Street",
"company" : "Sample Company LTD",
"datecreated" : "2019-04-02 13:38:28",
"billing_street" : "123 Road Street",
"shipping_country" : "235",
"city" : "London",
"billing_zip" : "WC1 ASW",
"shipping_zip" : "WC1 ASW",
"longitude" : null,
"registration_confirmed" : "1",
"billing_city" : "London",
"state" : "Greater London",
"phonenumber" : "+44 210 7298299",
"billing_country" : "235",
"address" : "123 Road Street",
"vat" : "123456789",
"active" : "1",
"stripe_id" : null
}
]Podrás seguir este ejemplo, para cada caso de uso, en los siguientes artículos, mostraremos cómo ejecutar solicitudes para cada módulo de Ofilany y podrás tener ejemplos y estructuras de cada tipo de datos.
Todos los comandos admiten campos personalizados.
Consulta la sección Campos personalizados para garantizar la correcta implementación de cada solicitud que incluya campos personalizados.
