¿Que es API?
Manejo del Error
Seguridad en las APIs
Solución y y gestión de APIs con el API Manager de Onesait Plataform

¿Que es API?

API (Application Programming Interface) es la definición de un conjunto de reglas, especificaciones, protocolos y funciones que las aplicaciones pueden usar para intercambiar información.

Las APIs son creadas para satisfacer la necesidad de un grupo de clientes (Consumidores) así, han sido diseñadas de una forma genérica, satisfaciendo los casos de uso que han sido adaptado a las necesidades de un consumidor específico.

Son valoradas porque te permiten usar las características existentes en otro software y no tener que reinventar la rueda constantemente. Te permite simplificar el desarrollo de software, sin tener que escribir código de cero.

En siguiente presentación, nos centraremos plasmar las principales convenciones y buenas prácticas a llevar a cabo en la creación de APIs en los productos Onesait (Onesait API) :

OpenAPI 3 y API Rest.
Nomenclatura, esquema y criterio unificado.
HTTP Verbs y códigos de respuesta unificados.

Versión en ingles:

Versión en español:

Manejo del Error

Del documento anterior, merece la pena destacar la sección dedicada al manejo de códigos de errores.

El manejo de errores es muy importante en nuestra arquitectura y desarrollo, especialmente para los diseñadores de API

Desde la perspectiva del desarrollador consumiendo tu Web API, todo al otro lado de esa interfaz es una caja negra. Los errores así se convierten en una herramienta clave proporcionando contexto y visibilidad en como usar una API.

Sabemos que hay diferentes formas de interpretar los códigos HTTP, pero tratamos de mantenerlo claro y simple usando pocos códigos. Estos son los estándar y sus reglas.

200 - La aplicación lo proceso de forma satisfactoria (no sera usado para devolver errores en el body)
201 - Recurso creado
400 - Error de validación o funcional
401 - No autorizado
403 - Prohibido
404 - No encontrado
500 - Cualquier error no funcional que ocurra (errores descontrolados y no funcionales)

Error 404

Para el error 400 damos información (errores de validación o funcionales) en el cuerpo de esta manera:

{
  "errors": [
    {
      "code": "XXX",
      "message": "DESC XXX"
    },
    {
      "code": "YYY",
      "message": "DESC YYY"
    },
    …..
  ]
}

Seguridad en las APIs

En el siguiente enlace Seguridad en las APIs del marco de referencia de seguridad, se puede encontrar los principales estándares y patrones al respecto a la seguridad de las APIs.

Solución y y gestión de APIs con el API Manager de Onesait Plataform

https://onesaitplatform.atlassian.net/wiki/spaces/OP/pages/49807638/API+Manager+Guides