Referencia de la API

Referencia de la API

Bienvenido a la API de Soyio. A través de ella, podrás acceder a los distintos endpoints que te permitirán operar y obtener información de los recursos de la plataforma.

¿Recién empezando? Te recomendamos revisar nuestra guía de introducción.

La API está organizada alrededor de REST. Nuestra API posee URLs predecibles y orientadas a recursos, y utiliza códigos de respuesta HTTP para indicar el resultado de la llamada. Todas las respuestas de la API retornan objetos JSON, incluyendo los errores, sin embargo, nuestros SDK convertirán las respuestas a objetos específicos de cada lenguaje.

Utilizamos características incluidas en el protocolo HTTP, como autenticación y verbos, los cuales son soportados por la gran mayoría de los clientes HTTP. Soportamos CORS, lo cual permite interactuar de manera segura con nuestra API desde una aplicación web desde el lado del cliente.

Campos no documentados en el request body

Todos los endpoints procesan únicamente los campos documentados en el schema de su request body. Si envías una propiedad no documentada, la API la ignora silenciosamente: no la guarda ni invalida una solicitud que, de otro modo, sería válida.

Los campos documentados mantienen sus validaciones. Omitir un campo obligatorio o enviar un valor inválido puede producir un error. Los objetos declarados como libres, por ejemplo metadata, sí aceptan propiedades adicionales. Esta regla aplica solo al request body, no a parámetros de path o query.

Puedes también descargar nuestra especificación OpenAPI completa.

Si usas Postman, puedes importarla pegando la siguiente URL en Import > Link: https://soyio-docs.s3.amazonaws.com/soyio-open-api.yaml