# Primeros pasos

Se recomienda leer toda esta sección, ya que en esta se encuentra información relevante sobre el uso de credenciales de acceso y estas son necesarias para cualquier interacción con la API de manera correcta.

# Credenciales de acceso

Para cualquier interacción con la API es necesario envíar las credenciales de acceso, en esta sección se explicará como obtenerlas.

Para usar la API de Wasi debes tener un Plan Pro, contando con ello por favor inicia sesión y dirígete al menú Configuración / Ajustes generales, en la parte inferior en la sección API de Wasi encontrarás el botón Generar token, al dar click en el, obtendrás dos valores con el siguiente formato:

id_company : #############

Y también:

wasi_token : XXXX_XXXX_XXXX_XXXX

❗️ Importante

Estos valores serán necesarios para realizar cualquier petición a la API.

❗️ Nota

Si deseas cambiar el token de acceso puedes dar click en el boton Generar un nuevo token, o si quieres desactivar el acceso a la API puedes dar click en el boton Desactivar token.

# Envío de las credenciales

Para cualquier interacción con la API es necesario envíar las credenciales de acceso, en esta sección se explicará como hacerlo.

Para el siguiente ejemplo se supondrá que se cuenta con:

wasi_token : ABCD_EFGH_IJKL_MNOP;

Y también:

id_company : 1234567890

Suponiendo que quieres obtener todo el listado de países soportado por Wasi, de acuerdo a la documentación, la uri para esto es:

https://api.wasi.co/v1/location/all-countries

En el caso de una petición GET debés incluir al final de la URI estos dos parametros asi:

https://api.wasi.co/v1/location/all-countries?id_company=1234567890&wasi_token=ABCD_EFGH_IJKL_MNOP

❗️ Importante

Por seguridad se recomienda enviar como parametros a través de POST los valores de id_company y wasi_token.

❗️ Importante

Para todas las peticiones deben usar el protocolo HTTPS por seguridad.

# Respuesta obtenida

Cada que haces un llamado a la API de Wasi, en la respuesta tendrás el valor status, este te indica si la petición fue exitosa u ocurrio algo inesperado; para el ejemplo de la sección anterior de obtener todos los países soportados por Wasi, se uso la URI:

api.wasi.co/v1/location/all-countries?id_company=1234567890&wasi_token=ABCD_EFGH_IJKL_MNOP

Y la respuesta esperada seria similar a:

{
    "0": {
        "id_country": "1",
        "name": "Colombia",
        "iso": "CO"
    },
    "1": {
        "id_country": "5",
        "name": "Argentina",
        "iso": "AR"
    },
    "2": {
        "id_country": "9",
        "name": "Belgium",
        "iso": "BE"
    },
    "status": "success"
}

Como puedes apreciar en el ejemplo el valor de status es success, esto quiere decir que la petición fue exitosa; de no ser asi el valor de status debería ser error, en este caso contarás con dos valores extra, code que es un identificador del error y message que es una frase corta en ingles que indica por que ocurre la situación, por ejemplo:

{
    "status": "error",
    "code": "0",
    "message": "id_company or wasi_token is wrong."
}

❗️ Nota

En este error común la variable message nos indica que id_company o wasi_token tienen un valor erroneo y se deben verificar.

❗️ Importante

La API de Wasi cuenta con cache en algunas peticiones clave para dar una rápida respuesta, esto hace que algunos datos tarden algunos minutos en refrescarse.

# Tabla de errores

En la siguiente tabla se encuentra la clasificación de los posibles errores obtenidos al hacer un llamado incorrecto a la API.

Código	Tipo	Descripción
0	Credenciales	Los valores de id_company y wasi_token tienen un valor erroneo y se deben verificar.
1	Permisos	No cuenta con permisos para realizar la acción, por ejemplo, cuando no se cuenta con un plan Pro o cuando se intenta obtener información de un inmueble de una empresa que aún no es aliada.
2	Validación	Uno o más de los parametros enviados presenta errores.

← Introducción Propiedades →