¿Cómo funciona?

Hasta el momento hablamos mucho de las APIs, pero puede ser difícil de imaginar su funcionamiento si nunca se trabajó con una. Pero es muy simple.

Al igual que un sitio web, una API tiene una URL. Generalmente, es un subdominio del dominio principal. Se indica también la versión de la API a utilizar, para evitar problemas de compatibilidades con otras versiones disponibles. Por ejemplo:

https://api.persat.com.ar/v1

Luego el tipo de objeto que queremos obtener. Por ejemplo, tus clientes:

https://api.persat.com.ar/v1/clients

A esa URL podemos hacerles diferentes tipos de llamadas, o métodos HTTP:

• GET para leer los datos de los elementos

• POST para crear un elemento nuevo

• PUT para modificar los datos de un elemento

• DELETE para eliminar un elemento

¿En que formato se recibe la información?

La respuesta a cada una de estas llamadas será un conjunto de datos en formato JSON. Este tipo de formato permite estructurar información a partir de texto plano. Por ejemplo, si pedimos los datos de un cliente veríamos algo así:

{
    "success": true,
    "data": {
        "uid_client": "CL-0044",
        "company_name": "Persat",
        "company_description": "Logistica GPS",
        "latitude": -34.598236,
        "longitude": -58.507811,
        "street": "San Nicolás",
        "street_nbr": "3940",
        "neighborhood": "Devoto",
        "city": "CABA,
        "country": "Argentina",
        "custom_fields": {
            "1": {
                "name": "Teléfono",
                "value": "11-4504-5300"
            }
        }
    }
}

Lo mejor es que el formato JSON puede ser comprendido y utilizado por cualquier lenguaje de programación: PHP, Java, .NET, Javascript, Phyton y más. Por eso, JSON se ha convertido en el lenguaje por defecto de todos las APIs en la actualidad.

¿Quienes pueden utilizar la API?

La API puede ser usada mientras tengas una cuenta activa en Persat. Solo necesitás un API key para poder acceder a los recursos.