API
Autenticación, X-CommunityId, errores, paginación, el SDK en /sdk.js y cada endpoint.
- Introducción a la APILa API REST de Memberfy: dirección, formato, cabeceras y por dónde empezar a integrar.
- AutenticaciónCómo obtener el token con correo y contraseña, enviarlo en cada llamada, cuánto dura, las rutas públicas, actuar en nombre de otro perfil y cómo montar una cuenta de integración segura.
- X-CommunityIdLa cabecera que dice en qué comunidad ocurre cada llamada y en cuál se comprueba tu rol. Por qué ninguna ruta lleva la comunidad en el camino, dónde encontrar el id de la comunidad y los errores de quien la olvida.
- Orden de creaciónQué tiene que existir antes de cada llamada, de dónde sale cada id, la secuencia de los flujos habituales y los errores que aparecen cuando se salta un paso.
- Respuestas y erroresEl sobre de toda respuesta, el array errors que llega siempre, los códigos HTTP y qué hacer con cada uno, los mensajes de validación y de negocio, el idioma de los mensajes y los elementos eliminados.
- PaginaciónCómo se dividen los listados en páginas con page y limit, el bloque pagination de la respuesta, cómo recorrerlo todo y cómo se combinan filtros y paginación.
- SDK de JavaScriptEl cliente que la API publica en /sdk.js y /sdk.mjs, generado a partir de la propia especificación. Cómo cargarlo en el navegador y en Node, los métodos por tema, cómo pasar parámetros y cuerpo, el tratamiento de errores y las opciones del cliente.
- Referencia de la APICada endpoint público de la API, agrupado por tema, generado a partir de la especificación OpenAPI que publica la propia API.